Passer au contenu principal
POST
Lancer un audit de pages
Audite jusqu’à 50 pages suivies, ou toutes les pages suivies avec all défini sur true. La requête renvoie 202 avec l’audit et un en-tête Location. Interrogez Obtenir un audit de pages, ou abonnez un webhook d’intégration à site_audit.completed. Les pages déjà en cours d’audit sont signalées comme SKIPPED dans l’audit. Chaque page auditée consomme 5 crédits, comme dans le tableau de bord. Le solde est vérifié avant l’acceptation ; chaque page réserve ses crédits au démarrage de son traitement et les consomme à l’enregistrement de ses résultats. creditsReserved est le budget de l’audit, pas une réservation immédiate ni une facture. Envoyez dryRun: true pour le prévisualiser sans rien lancer. Un 202 signifie que la demande est enregistrée durablement, pas que toutes les pages ont démarré. La requête met elle-même en file un audit de 100 pages à auditer ou moins. Un audit plus grand est renvoyé sans attendre : ses pages sont QUEUED, et une tâche d’arrière-plan qui s’exécute toutes les cinq minutes les met en file, parfois avant l’arrivée de la réponse. La mise en file est relancée dans les 24 heures qui suivent l’acceptation, avec 12 tentatives au plus, la première comprise ; une tentative interrompue avant d’enregistrer son issue peut s’exécuter de nouveau dans cette fenêtre. Les pages que la file n’a pas prises à ce terme sont FAILED. Chaque tentative réutilise les mêmes clés, si bien qu’une page n’est jamais mise en file ni débitée deux fois. Consultez le même audit plutôt que d’en créer un nouveau. Si le solde est déjà insuffisant, la requête renvoie 409 INSUFFICIENT_CREDITS et ne lance rien. Si le solde est épuisé après l’acceptation, la réponse dépend de l’avancement de l’audit. Lorsqu’aucune page n’a démarré et que la requête a mis elle-même l’audit en file (100 pages à auditer ou moins), le même 409 contient details.auditId : l’audit est conservé avec ses pages FAILED et reste consultable. Dans tous les autres cas, y compris un audit mis en file par la tâche d’arrière-plan, la réponse reste 202 : les pages qui n’ont pas pu démarrer sont FAILED, les pages déjà démarrées continuent, et l’audit indique l’issue de chaque page. 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.
string
requis
Jeton bearer de votre équipe.
string
requis
Clé unique pour cette opération, 255 caractères au maximum. Les réponses terminées sont rejouées pendant 24 heures.
string
requis
Identifiant du workspace. Le workspace doit appartenir à l’équipe du jeton.
string[]
Entre 1 et 50 identifiants de pages suivies. Ne peut pas être combiné avec all.
boolean
Audite toutes les pages suivies, dans la limite de 10 000. Au-delà, utilisez plusieurs requêtes avec pageIds. Ne peut pas être combiné avec pageIds.
Envoyez soit pageIds, soit all.
boolean
défaut:"false"
Renvoie les pages et creditsReserved sans lancer l’audit ni réserver de crédits. La réponse est 200 avec status: "PREVIEW" et id: null.

Réponse

Renvoie 202 avec un objet d’audit, ou 200 avec un audit PREVIEW lorsque dryRun vaut true. creditsReserved vaut 5 crédits par page à auditer et peut diminuer si des pages sont refusées à l’envoi. Pour un dry run, il s’agit du budget estimé. Consultez Obtenir un audit de pages pour les champs.

Requête et réponse synthétiques

Erreurs

Consultez Codes d’erreur pour les erreurs d’authentification, d’offre, d’idempotence et de serveur. Un jeton sans accès en écriture renvoie 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.