Obtenir un audit de prospection
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": [
{}
]
}
}Audits de prospection
Obtenir un audit de prospection
Lisez le rapport du prospect d’origine d’un audit de prospection.
GET
https://www.qwairy.co
/
api
/
v1
/
pitch-audits
/
{auditId}
Obtenir un audit de prospection
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": [
{}
]
}
}Renvoie le rapport d’audit de prospection du prospect d’origine, en lecture seule : profil, prompts, scores, concurrents, sources, insights, recommandations et co-concurrents.
Suivez
Lisez
string
requis
Jeton d’API bearer. Exemple :
Bearer qw-api-xxxParamètres de chemin
string
requis
Identifiant d’audit renvoyé par Lister les audits de prospection.
Paramètres de requête
boolean
défaut:"false"
Inclut le texte complet des réponses IA. Gardez la valeur par défaut pour un rapport de taille limitée ; demandez les réponses explicitement lorsqu’une analyse au niveau des preuves est nécessaire.
boolean
défaut:"false"
Ajoute la synthèse
scores complète à chaque ligne de coCompetitors. Utilisez cette extension pour comparer tous les co-concurrents en une seule requête.Réponse
boolean
true lorsque le rapport a été renvoyé.object
Identifiant et nom du workspace agence.
object
Afficher Rapport d’audit de prospection
Afficher Rapport d’audit de prospection
object
Le prospect d’origine ou le concurrent représenté par ce rapport.
array
Tous les sujets qui peuvent être demandés via
subjectId.object
Scores, fournisseurs, classement des concurrents, sources, insights, préparation technique, affirmations et recommandations.
boolean
Indique si les réponses complètes ont été demandées.
boolean
Indique si chaque ligne de co-concurrent inclut sa synthèse de scores complète.
number
Nombre de réponses disponibles dans le rapport.
array
Réponses IA complètes. Présent uniquement avec
includeAnswers=true.array
Marques présentes dans les mêmes réponses que le sujet actuel. Chaque ligne inclut un
subjectId résoluble, un reportUrl, des indicateurs de co-occurrence et, en option, scores.Exemple de requête pour le prospect d’origine
curl "https://www.qwairy.co/api/v1/pitch-audits/8a218180-6dd7-43c7-a481-f6a1cc72dfd8" \
-H "Authorization: Bearer qw-api-your-token-here"
Suivre le lien d’un co-concurrent
PrenezsubjectId et le reportUrl canonique directement dans une ligne de coCompetitors :
{
"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, ou consultez Obtenir le rapport d’un sujet. Un co-concurrent est une vue dérivée du même audit, pas un audit distinct.
Inclure les scores de tous les co-concurrents
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. Chaque ligne inclut les indicateurs de relation ainsi que scores.geoScore, scores.mentionRate, scores.avgPosition, scores.sentimentScore, scores.shareOfVoice et les indicateurs de citation. N’utilisez subjectId que si vous avez besoin du rapport dérivé complet.
Erreurs
| Statut | Code | Description |
|---|---|---|
| 400 | INVALID_PARAMETER | Paramètre de requête invalide |
| 401 | erreur de passerelle | Échec de l’authentification |
| 404 | PITCH_AUDIT_NOT_FOUND | Audit ou sujet demandé inaccessible |
| 429 | erreur de passerelle | Limite de débit dépassée ; respectez Retry-After |

