Lister les URL sources
curl --request GET \
--url https://www.qwairy.co/api/v1/brands/{brandId}/source-urls \
--header 'Authorization: <authorization>'import requests
url = "https://www.qwairy.co/api/v1/brands/{brandId}/source-urls"
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}/source-urls', 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
},
"sourceUrls": [
{
"url": "<string>",
"title": "<string>",
"domain": "<string>",
"isSelf": true,
"isCompetitor": true,
"competitors": [
{}
],
"totalMentions": 123,
"avgPosition": 123,
"shareOfVoice": 123,
"topics": [
{}
],
"tags": [
{}
]
}
]
}Sources
Lister les URL sources
Suivez les citations page par page.
GET
https://www.qwairy.co
/
api
/
v1
/
brands
/
{brandId}
/
source-urls
Lister les URL sources
curl --request GET \
--url https://www.qwairy.co/api/v1/brands/{brandId}/source-urls \
--header 'Authorization: <authorization>'import requests
url = "https://www.qwairy.co/api/v1/brands/{brandId}/source-urls"
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}/source-urls', 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
},
"sourceUrls": [
{
"url": "<string>",
"title": "<string>",
"domain": "<string>",
"isSelf": true,
"isCompetitor": true,
"competitors": [
{}
],
"totalMentions": 123,
"avgPosition": 123,
"shareOfVoice": 123,
"topics": [
{}
],
"tags": [
{}
]
}
]
}Liste les URL citées avec leur nombre d’occurrences, leur position moyenne, leur taxonomie et leurs indicateurs de relation pour le périmètre de réponses sélectionné.
string
requis
Jeton bearer. Exemple :
Bearer qw-api-xxxGET /api/v1/brands/{brandId}/source-urls
Paramè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 sur un domaine précis
string
Filtre sur vos propres domaines :
true ou falsestring
Filtre sur les domaines concurrents :
true ou falsenumber
défaut:"50"
Nombre maximal d’URL renvoyées (maximum : 100)
number
défaut:"0"
Nombre de résultats à ignorer pour la pagination
string
défaut:"mentions"
Champ de tri :
mentions, position, shareOfVoice, urlstring
défaut:"desc"
Ordre de tri :
asc ou descRéponse
boolean
Indique si la requête a réussi
object
array
Afficher Objet URL source
Afficher Objet URL source
string
URL complète de la page citée
string
Titre de la page (s’il est disponible)
string
Nom de domaine
boolean
Indique s’il s’agit de votre domaine
boolean
Indique s’il s’agit du domaine d’un concurrent direct
array
Noms des concurrents directs associés à cette URL
number
Nombre total de citations
number
Position moyenne dans les listes de sources
number
Part de l’ensemble des citations (0 à 100)
array
Objets Topic associés, avec
id et textarray
Objets Tag associés, avec
id et nameExemple de requête
curl "https://www.qwairy.co/api/v1/brands/YOUR_BRAND_ID/source-urls?isSelf=true&limit=10" \
-H "Authorization: Bearer $QWAIRY_API_TOKEN"
Exemple de réponse
{
"success": true,
"pagination": {
"total": 156,
"count": 2,
"limit": 10,
"offset": 0
},
"sourceUrls": [
{
"url": "https://acme.example/guides/warehouse-exports",
"title": "Warehouse export guide",
"domain": "acme.example",
"isSelf": true,
"isCompetitor": false,
"competitors": [],
"totalMentions": 45,
"avgPosition": 2.1,
"shareOfVoice": 3.5,
"topics": [{ "id": "topic_01", "text": "Data exports" }],
"tags": [{ "id": "tag_01", "name": "integrations" }]
},
{
"url": "https://rival.example/docs/export-review",
"title": "Export integration overview",
"domain": "rival.example",
"isSelf": false,
"isCompetitor": true,
"competitors": ["Rival Labs"],
"totalMentions": 32,
"avgPosition": 3.4,
"shareOfVoice": 2.1,
"topics": [{ "id": "topic_01", "text": "Data exports" }],
"tags": []
}
]
}
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 |
shareOfVoice correspond aux occurrences de citation de l’URL divisées par toutes les occurrences de citation du périmètre sélectionné. Consultez Limites de débit pour la gestion des nouvelles tentatives.