Lister les audits de prospection
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": {}
}
]
}Audits de prospection
Lister les audits de prospection
Listez les instantanés d’audits de prospection, en lecture seule, disponibles pour votre workspace agence.
GET
https://www.qwairy.co
/
api
/
v1
/
pitch-audits
Lister les audits de prospection
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": {}
}
]
}Renvoie les audits de prospection créés par le workspace agence rattaché au jeton d’API. Cet endpoint est en lecture seule et ne lance, ne relance ni ne modifie jamais un audit.
Seuls les audits de prospection appartenant à un workspace agence associé à l’équipe du jeton sont renvoyés. L’accès général à l’API reste soumis aux règles d’offre décrites dans l’Introduction.
string
requis
Jeton d’API bearer. Exemple :
Bearer qw-api-xxxParamètres de requête
string
Filtre par
PENDING, RUNNING, RECOVERING, AWAITING_PROMPTS, COMPLETED ou FAILED.number
défaut:"50"
Nombre d’audits à renvoyer. Maximum : 100.
number
défaut:"0"
Nombre d’audits à ignorer.
Réponse
object
Total, nombre, limite et décalage de la page actuelle.
array
Afficher Résumé de l’audit de prospection
Afficher Résumé de l’audit de prospection
string
Identifiant de l’audit de prospection.
string
Nom du prospect.
string
Domaine du prospect.
string
Statut actuel de l’audit.
object
Score GEO, taux de mention, position, sentiment, part de voix, citations et totaux lorsqu’ils sont disponibles.
array
Concurrents détectés. Chaque ligne inclut un
subjectId accepté par l’endpoint de détail.boolean
Indique si le rapport terminé est prêt à être lu.
object
Identifiant et nom du workspace agence.
Exemple de requête
curl "https://www.qwairy.co/api/v1/pitch-audits?status=COMPLETED&limit=20" \
-H "Authorization: Bearer qw-api-your-token-here"
Exemple de réponse
{
"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" }
}
]
}
Étape suivante
Utilisez l’identifiant d’audit renvoyé avec Obtenir un audit de prospection. Utilisez lesubjectId d’un concurrent avec Obtenir le rapport d’un sujet.
Erreurs
| Statut | Code | Description |
|---|---|---|
400 | INVALID_PARAMETER | Valeur de statut ou de pagination invalide |
401 | erreur de passerelle | Échec de l’authentification |
429 | erreur de passerelle | Limite de débit dépassée ; respectez Retry-After |

