Lister les concurrents
curl --request GET \
--url https://www.qwairy.co/api/v1/brands/{brandId}/competitors \
--header 'Authorization: <authorization>'import requests
url = "https://www.qwairy.co/api/v1/brands/{brandId}/competitors"
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/brands/{brandId}/competitors', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"pagination": {
"total": 123,
"count": 123,
"limit": 123,
"offset": 123
},
"competitors": [
{
"id": "<string>",
"name": "<string>",
"domain": "<string>",
"relationship": "<string>",
"totalMentions": 123,
"shareOfVoice": 123,
"avgPosition": 123,
"avgSentiment": {}
}
]
}Concurrents
Lister les concurrents
Suivez les mentions, la part de voix et le positionnement des concurrents.
GET
https://www.qwairy.co
/
api
/
v1
/
brands
/
{brandId}
/
competitors
Lister les concurrents
curl --request GET \
--url https://www.qwairy.co/api/v1/brands/{brandId}/competitors \
--header 'Authorization: <authorization>'import requests
url = "https://www.qwairy.co/api/v1/brands/{brandId}/competitors"
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/brands/{brandId}/competitors', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"pagination": {
"total": 123,
"count": 123,
"limit": 123,
"offset": 123
},
"competitors": [
{
"id": "<string>",
"name": "<string>",
"domain": "<string>",
"relationship": "<string>",
"totalMentions": 123,
"shareOfVoice": 123,
"avgPosition": 123,
"avgSentiment": {}
}
]
}Liste les domaines concurrents et leurs indicateurs de mention pour le périmètre sélectionné. L’ensemble de relations par défaut est
Consultez Limites de débit pour la gestion des nouvelles tentatives.
SELF,DIRECT ; ajoutez INDIRECT explicitement si nécessaire. Sur cet endpoint, la part de voix utilise les occurrences de mentions de l’ensemble de relations sélectionné.
Consultez Entités pour la structure complète de l’objet Competitor.
string
requis
Jeton bearer. Exemple :
Bearer qw-api-xxxParamètres de chemin
string
requis
L’identifiant unique de la marque
Paramètres de requête
number
Nombre de jours à inclure. Sans valeur, toutes les données sont renvoyées.
string
Date de début au format
YYYY-MM-DD. Fournissez-la avec endDate ; une borne seule est actuellement ignorée. Choisissez soit period, soit la paire de dates complète.string
Date de fin au format
YYYY-MM-DD. Fournissez-la avec startDate ; une borne seule est actuellement ignorée. Ne combinez pas la paire de dates complète avec period.string
Filtre par fournisseur IA. Accepte plusieurs valeurs séparées par des virgules (par exemple
chatgpt,claude).string
Filtre par identifiant de Topic. Accepte plusieurs valeurs séparées par des virgules (par exemple
id1,id2).string
Filtre par identifiant de Tag. Accepte plusieurs valeurs séparées par des virgules (par exemple
id1,id2).string
Filtre par type de prompt :
TOFU, MOFU, BOFU ou POST_PURCHASEstring
défaut:"SELF,DIRECT"
Filtre par type de relation. Accepte plusieurs valeurs séparées par des virgules :
SELF, DIRECT, INDIRECT. Par défaut : SELF,DIRECT.number
défaut:"50"
Nombre maximal de résultats renvoyés (maximum : 100)
number
défaut:"0"
Nombre de résultats à ignorer pour la pagination
string
défaut:"mentions"
Champ de tri :
mentions, position, sentiment, shareOfVoice, namestring
défaut:"desc"
Ordre de tri :
asc ou descRéponse
Renvoie les concurrents du filtre de relation demandé.INDIRECT n’est exclu que par le filtre par défaut.
boolean
Indique si la requête a réussi
object
array
Afficher Objet Competitor
Afficher Objet Competitor
string
Identifiant du concurrent
string
Nom du concurrent
string
Domaine du concurrent
string
SELF, DIRECT ou INDIRECT, selon le filtre relationshipnumber
Nombre total de mentions
number
Occurrences de mentions de cette ligne divisées par toutes les occurrences de mentions de l’ensemble de relations sélectionné
number
Position moyenne dans les réponses
number | null
Sentiment moyen des mentions sur une échelle de 0 à 100, ou
nullExemple de requête
curl "https://www.qwairy.co/api/v1/brands/YOUR_BRAND_ID/competitors?limit=10&offset=0" \
-H "Authorization: Bearer $QWAIRY_API_TOKEN"
Exemple de réponse
{
"success": true,
"pagination": {
"total": 10,
"count": 2,
"limit": 10,
"offset": 0
},
"competitors": [
{
"id": "competitor_self",
"name": "Acme Analytics",
"domain": "acme.example",
"relationship": "SELF",
"totalMentions": 104,
"shareOfVoice": 8.13,
"avgPosition": 2.1,
"avgSentiment": 78.1
},
{
"id": "competitor_01",
"name": "Rival Labs",
"domain": "rival.example",
"relationship": "DIRECT",
"totalMentions": 111,
"shareOfVoice": 8.73,
"avgPosition": 1.8,
"avgSentiment": 75.2
}
]
}
Erreurs
| Statut | Signification |
|---|---|
400 | Paramètre de requête ou filtre de relation invalide |
401 | Jeton d’API manquant ou invalide |
404 | Marque introuvable ou inaccessible |
429 | Limite de débit dépassée ; respectez Retry-After |

