Ajouter des pages à suivre
curl --request POST \
--url https://www.qwairy.co/api/v1/brands/{brandId}/site-diagnostics/pages \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"urls": [
"<string>"
]
}
'import requests
url = "https://www.qwairy.co/api/v1/brands/{brandId}/site-diagnostics/pages"
payload = { "urls": ["<string>"] }
headers = {
"Authorization": "<authorization>",
"Idempotency-Key": "<idempotency-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: '<authorization>',
'Idempotency-Key': '<idempotency-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({urls: ['<string>']})
};
fetch('https://www.qwairy.co/api/v1/brands/{brandId}/site-diagnostics/pages', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Diagnostic du site
Ajouter des pages à suivre
Ajoutez jusqu’à 50 URL du domaine du workspace au Diagnostic du site. Chaque URL indique si elle est ajoutée, déjà suivie, invalide ou hors du domaine.
POST
https://www.qwairy.co
/
api
/
v1
/
brands
/
{brandId}
/
site-diagnostics
/
pages
Ajouter des pages à suivre
curl --request POST \
--url https://www.qwairy.co/api/v1/brands/{brandId}/site-diagnostics/pages \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"urls": [
"<string>"
]
}
'import requests
url = "https://www.qwairy.co/api/v1/brands/{brandId}/site-diagnostics/pages"
payload = { "urls": ["<string>"] }
headers = {
"Authorization": "<authorization>",
"Idempotency-Key": "<idempotency-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: '<authorization>',
'Idempotency-Key': '<idempotency-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({urls: ['<string>']})
};
fetch('https://www.qwairy.co/api/v1/brands/{brandId}/site-diagnostics/pages', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Ajoute jusqu’à 50 URL du domaine du workspace aux pages suivies. Une URL déjà suivie est signalée comme
Consultez Codes d’erreur pour les erreurs d’authentification, d’offre, d’idempotence et de serveur. Un jeton sans accès en écriture renvoie
already_monitored. Ajouter une page ne l’audite pas : lancez un audit avec Lancer un audit de pages.
Nécessite une offre Business, Agency Business ou Enterprise active, et un jeton d’API dont l’accès en écriture a été activé par un Propriétaire ou un Manager. Consultez Écrire des données pour l’activation, l’idempotence, les requêtes conditionnelles et la gestion des erreurs.
Clé unique pour cette opération, 255 caractères au maximum. Les réponses terminées sont rejouées pendant 24 heures.
Réponse
Renvoie200 avec un tableau items, une entrée pour chaque URL soumise.
| Résultat | Signification |
|---|---|
added | La page est désormais suivie ; pageId l’identifie |
already_monitored | La page était déjà suivie |
invalid | L’URL n’est pas valide |
outside_domain | L’URL n’est pas sur le domaine du workspace |
pageId vaut null lorsque l’URL n’a pas été ajoutée.
Requête et réponse synthétiques
curl -X POST "https://www.qwairy.co/api/v1/brands/$BRAND_ID/site-diagnostics/pages" \
-H "Authorization: Bearer $QWAIRY_API_TOKEN" \
-H "Idempotency-Key: monitor-pages-001" \
-H "Content-Type: application/json" \
-d '{"urls":["https://example.com/pricing","https://example.com/blog","https://other.example/page"]}'
{
"items": [
{
"url": "https://example.com/pricing",
"outcome": "added",
"pageId": "99999999-0000-4000-8000-000000000000"
},
{
"url": "https://example.com/blog",
"outcome": "already_monitored",
"pageId": "99999999-1111-4000-8000-000000000000"
},
{
"url": "https://other.example/page",
"outcome": "outside_domain",
"pageId": null
}
]
}
Erreurs
| Statut | Code | Cause |
|---|---|---|
400 | INVALID_REQUEST | La liste est vide, contient plus de 50 URL, ou est mal formée |
404 | RESOURCE_NOT_FOUND | Le workspace est absent ou inaccessible |
409 | CONFLICT | La requête entre en conflit avec l’état actuel |
403 API_KEY_READ_ONLY. Sur 429, respectez Retry-After. Si le limiteur d’écriture est indisponible ou si les écritures sont suspendues, la requête renvoie 503 SERVICE_UNAVAILABLE et rien ne change.
