List Pitch Audits
curl --request GET \
--url https://www.qwairy.co/api/v1/pitch-audits \
--header 'Authorization: <authorization>'import requests
url = "https://www.qwairy.co/api/v1/pitch-audits"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://www.qwairy.co/api/v1/pitch-audits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"pagination": {},
"audits": [
{
"id": "<string>",
"brandName": "<string>",
"domain": "<string>",
"status": "<string>",
"scores": {},
"competitors": [
{}
],
"reportReady": true,
"team": {}
}
]
}Pitch audits
List Pitch Audits
List the read-only Pitch Audit snapshots available to your agency workspace.
GET
https://www.qwairy.co
/
api
/
v1
/
pitch-audits
List Pitch Audits
curl --request GET \
--url https://www.qwairy.co/api/v1/pitch-audits \
--header 'Authorization: <authorization>'import requests
url = "https://www.qwairy.co/api/v1/pitch-audits"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://www.qwairy.co/api/v1/pitch-audits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"pagination": {},
"audits": [
{
"id": "<string>",
"brandName": "<string>",
"domain": "<string>",
"status": "<string>",
"scores": {},
"competitors": [
{}
],
"reportReady": true,
"team": {}
}
]
}Returns Pitch Audits created by the agency workspace attached to the API token. This endpoint is read-only and never starts, retries, or modifies an audit.
Only Pitch Audits owned by an agency workspace associated with the token’s team are returned. General API access still follows the plan rules in Introduction.
string
required
Bearer API token. Example:
Bearer qw-api-xxxQuery parameters
string
Filter by
PENDING, RUNNING, RECOVERING, AWAITING_PROMPTS, COMPLETED, or FAILED.number
default:"50"
Number of audits to return. Maximum: 100.
number
default:"0"
Number of audits to skip.
Response
object
Total, count, limit, and offset for the current page.
array
Show Pitch Audit summary
Show Pitch Audit summary
string
Pitch Audit ID.
string
Prospect name.
string
Prospect domain.
string
Current audit status.
object
GEO score, mention rate, position, sentiment, share of voice, citations, and totals when available.
array
Detected competitors. Each row includes a
subjectId accepted by the detail endpoint.boolean
Whether the completed report is ready to read.
object
Agency workspace ID and name.
Synthetic request
curl "https://www.qwairy.co/api/v1/pitch-audits?status=COMPLETED&limit=20" \
-H "Authorization: Bearer qw-api-your-token-here"
Synthetic response
{
"success": true,
"pagination": { "total": 8, "count": 1, "limit": 20, "offset": 0 },
"audits": [
{
"id": "8a218180-6dd7-43c7-a481-f6a1cc72dfd8",
"brandName": "Northstar Labs",
"domain": "northstar.example",
"status": "COMPLETED",
"promptCount": 20,
"competitorCount": 4,
"scores": { "geoScore": 71, "mentionRate": 60 },
"competitors": [
{
"subjectId": "orbit.example",
"name": "Orbit Systems",
"domain": "orbit.example",
"score": 64
}
],
"reportReady": true,
"team": { "id": "team-123", "name": "Agency workspace" }
}
]
}
Next step
Use the returned audit ID with Get Pitch Audit. Use a competitorsubjectId with Get Pitch Audit Subject Report.
Errors
| Status | Code | Description |
|---|---|---|
400 | INVALID_PARAMETER | Invalid status or pagination value |
401 | gateway error | Authentication failed |
429 | gateway error | Rate limit exceeded; honor Retry-After |