Get Pitch Audit
curl --request GET \
--url https://www.qwairy.co/api/v1/pitch-audits/{auditId} \
--header 'Authorization: <authorization>'import requests
url = "https://www.qwairy.co/api/v1/pitch-audits/{auditId}"
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/{auditId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"team": {},
"audit": {
"reportSubject": {},
"availableSubjects": [
{}
],
"summary": {},
"answersIncluded": true,
"coCompetitorScoresIncluded": true,
"answerCount": 123,
"answers": [
{}
],
"coCompetitors": [
{}
]
}
}Pitch audits
Get Pitch Audit
Read the original prospect report for a Pitch Audit.
GET
https://www.qwairy.co
/
api
/
v1
/
pitch-audits
/
{auditId}
Get Pitch Audit
curl --request GET \
--url https://www.qwairy.co/api/v1/pitch-audits/{auditId} \
--header 'Authorization: <authorization>'import requests
url = "https://www.qwairy.co/api/v1/pitch-audits/{auditId}"
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/{auditId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"team": {},
"audit": {
"reportSubject": {},
"availableSubjects": [
{}
],
"summary": {},
"answersIncluded": true,
"coCompetitorScoresIncluded": true,
"answerCount": 123,
"answers": [
{}
],
"coCompetitors": [
{}
]
}
}Returns the original prospect’s read-only Pitch Audit report: profile, prompts, scores, competitors, sources, insights, recommendations, and co-competitors.
Follow
Read
string
required
Bearer API token. Example:
Bearer qw-api-xxxPath parameters
string
required
Pitch Audit ID returned by List Pitch Audits.
Query parameters
boolean
default:"false"
Include full AI answer text. Keep the default for a bounded report payload; request answers explicitly when evidence-level analysis is required.
boolean
default:"false"
Attach the complete
scores summary to every coCompetitors row. Use this expansion to compare all co-competitors in one request.Response
boolean
true when the report was returned.object
Agency workspace ID and name.
object
Show Pitch Audit report
Show Pitch Audit report
object
The original prospect or competitor represented by this report.
array
Every subject that can be requested through
subjectId.object
Scores, providers, competitor leaderboard, sources, insights, technical readiness, claims, and recommendations.
boolean
Whether full answer evidence was requested.
boolean
Whether every co-competitor row includes its full score summary.
number
Number of answers available in the report.
array
Full AI answer evidence. Present only when
includeAnswers=true.array
Brands appearing in the same answers as the current subject. Every row includes a resolvable
subjectId, reportUrl, co-occurrence metrics, and optionally scores.Synthetic request for the original prospect
curl "https://www.qwairy.co/api/v1/pitch-audits/8a218180-6dd7-43c7-a481-f6a1cc72dfd8" \
-H "Authorization: Bearer qw-api-your-token-here"
Follow a co-competitor link
TakesubjectId and the canonical reportUrl directly from a coCompetitors row:
{
"id": "orbit.example",
"subjectId": "orbit.example",
"name": "Orbit Systems",
"sharedAnswers": 12,
"subjectAvgPosition": 2.1,
"competitorAvgPosition": 1.7,
"sharedSourcesCount": 9,
"reportUrl": "/api/v1/pitch-audits/8a218180-6dd7-43c7-a481-f6a1cc72dfd8/reports/orbit.example"
}
reportUrl, or see Get Pitch Audit Subject Report. A co-competitor is a derived view of the same audit, not a separate audit record.
Include every co-competitor score
curl "https://www.qwairy.co/api/v1/pitch-audits/8a218180-6dd7-43c7-a481-f6a1cc72dfd8?includeCoCompetitorScores=true" \
-H "Authorization: Bearer qw-api-your-token-here"
audit.coCompetitors. Each row includes the relationship metrics plus scores.geoScore, scores.mentionRate, scores.avgPosition, scores.sentimentScore, scores.shareOfVoice, and citation metrics. Use subjectId only when you need the full derived report.
Errors
| Status | Code | Description |
|---|---|---|
| 400 | INVALID_PARAMETER | Invalid query parameter |
| 401 | gateway error | Authentication failed |
| 404 | PITCH_AUDIT_NOT_FOUND | Audit or requested subject is not accessible |
| 429 | gateway error | Rate limit exceeded; honor Retry-After |

