Lister les Topics
curl --request GET \
--url https://www.qwairy.co/api/v1/brands/{brandId}/keywords \
--header 'Authorization: <authorization>'import requests
url = "https://www.qwairy.co/api/v1/brands/{brandId}/keywords"
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}/keywords', 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
},
"keywords": [
{
"id": "<string>",
"keyword": "<string>",
"totalPrompts": 123,
"totalAnswers": 123,
"brandMentionRate": 123,
"shareOfVoice": 123,
"avgSentiment": 123
}
]
}Topics
Lister les Topics
Analysez la performance par Topic (keyword).
GET
https://www.qwairy.co
/
api
/
v1
/
brands
/
{brandId}
/
keywords
Lister les Topics
curl --request GET \
--url https://www.qwairy.co/api/v1/brands/{brandId}/keywords \
--header 'Authorization: <authorization>'import requests
url = "https://www.qwairy.co/api/v1/brands/{brandId}/keywords"
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}/keywords', 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
},
"keywords": [
{
"id": "<string>",
"keyword": "<string>",
"totalPrompts": 123,
"totalAnswers": 123,
"brandMentionRate": 123,
"shareOfVoice": 123,
"avgSentiment": 123
}
]
}Liste les Topics avec le nombre de réponses et les indicateurs SELF au niveau des réponses pour le périmètre sélectionné. La route de l’API conserve les noms de champs
Consultez Limites de débit pour la gestion des nouvelles tentatives.
keywords et keyword par compatibilité.
Consultez Entités pour la structure complète de l’objet Topic.
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 Tag. Accepte plusieurs valeurs séparées par des virgules (par exemple
id1,id2).number
défaut:"50"
Nombre maximal de Topics renvoyés (maximum : 100)
number
défaut:"0"
Nombre de résultats à ignorer pour la pagination
string
défaut:"prompts"
Champ de tri :
prompts, answers, mentionRate, shareOfVoice, sentiment, keywordstring
défaut:"desc"
Ordre de tri :
asc ou descRéponse
boolean
Indique si la requête a réussi
object
array
Afficher Objet Topic
Afficher Objet Topic
string
Identifiant du Topic
string
Texte du Topic
number
Nombre de prompts associés à ce Topic
number
Réponses enregistrées dans le périmètre sélectionné
number
Réponses avec une mention SELF divisées par les réponses avec une mention SELF ou DIRECT
number
Occurrences de mentions SELF divisées par les occurrences de mentions SELF et DIRECT
number
Sentiment moyen des mentions SELF sur une échelle de 0 à 100 ;
0 est renvoyé en l’absence de mention SELF notéeExemple de requête
curl "https://www.qwairy.co/api/v1/brands/YOUR_BRAND_ID/keywords?limit=10" \
-H "Authorization: Bearer $QWAIRY_API_TOKEN"
Exemple de réponse
{
"success": true,
"pagination": {
"total": 25,
"count": 2,
"limit": 10,
"offset": 0
},
"keywords": [
{
"id": "topic_01",
"keyword": "data exports",
"totalPrompts": 15,
"totalAnswers": 120,
"brandMentionRate": 45.5,
"shareOfVoice": 32.1,
"avgSentiment": 78.3
},
{
"id": "topic_02",
"keyword": "analytics integrations",
"totalPrompts": 8,
"totalAnswers": 64,
"brandMentionRate": 28.1,
"shareOfVoice": 18.5,
"avgSentiment": 72.0
}
]
}
Erreurs
| Statut | Code | Description |
|---|---|---|
| 401 | erreur de passerelle | Jeton d’API manquant ou invalide |
| 404 | BRAND_NOT_FOUND | Marque inexistante ou inaccessible |
| 429 | erreur de passerelle | Limite de débit dépassée ; respectez Retry-After |

