Passer au contenu principal
Suivez une recommandation avec l’API REST : indiquez que vous travaillez dessus, suivez la page concernée, auditez cette page et soyez notifié à la fin de l’audit. Un audit de page consomme 5 crédits par page.

Avant de commencer

  • Une offre Business, Agency Business ou Enterprise, 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.
  • Un endpoint de webhook d’intégration abonné à site_audit.completed, ou un client capable d’interroger l’API. Consultez Webhooks d’intégration.
  • Des crédits pour les pages que vous auditez.
Toutes les valeurs sont synthétiques.

Étapes

1

Lire l’action et sa version

Lister les actions renvoie chaque action avec sa version. Choisissez l’action et notez son id et sa version.
2

Passer l’action en cours

Un 412 signifie que l’action a changé depuis votre lecture : relisez-la. Renvoyer le statut actuel ne change rien. Consultez Mettre à jour le statut d’une action.
3

Ajouter la page au Diagnostic du site

Vérifiez le outcome de chaque élément : added, already_monitored, invalid ou outside_domain. Conservez le pageId. Ajouter une page ne l’audite pas. Consultez Ajouter des pages à suivre.
4

Prévisualiser le coût de l’audit

Envoyez d’abord dryRun. La réponse est un audit PREVIEW avec id: null et les crédits qu’il utiliserait.
5

Lancer l’audit

Répétez la requête sans dryRun et avec un nouvel Idempotency-Key.
La réponse est 202 avec un en-tête Location et le budget de crédits de l’audit. L’audit accepté est conservé et une mise en file interrompue reprend automatiquement. Un audit de plus de 100 pages à auditer est renvoyé sans attendre, et une tâche d’arrière-plan met ses pages en file. Un solde insuffisant à l’acceptation renvoie 409 INSUFFICIENT_CREDITS et ne lance rien. Un solde épuisé après l’acceptation renvoie le même 409 avec details.auditId uniquement lorsqu’aucune page n’a démarré et que la requête a mis elle-même l’audit en file ; cet audit accepté reste consultable. Sinon, la réponse reste 202 et seules les pages qui n’ont pas pu démarrer échouent : continuez à suivre le même audit. Les pages déjà en cours d’audit sont signalées comme SKIPPED. Consultez Lancer un audit de pages.
6

Attendre site_audit.completed

Votre endpoint reçoit un événement signé lorsque toutes les pages sont terminées :
Dédupliquez sur id, puis lisez Obtenir un audit de pages avec data.auditId. Sans webhook, interrogez cet endpoint jusqu’à ce que status vaille COMPLETED.
7

Lire les résultats de la page

Obtenir une page suivie renvoie ses scores et ses problèmes ouverts. Comparez-les à la page avant le changement, sur la même page et la même fenêtre de temps.

Limites

  • COMPLETED signifie que chaque page a un résultat final, pas qu’elles ont toutes réussi. Lorsque counts indique des pages échouées ou ignorées, lisez l’audit pour voir lesquelles avant de décider de les auditer à nouveau. Les audits ultérieurs ne modifient pas ces résultats.
  • Le solde est vérifié à l’acceptation d’un audit de pages. Comme dans le tableau de bord, chaque page réserve ses 5 crédits au démarrage de son audit, et ils sont débités à l’enregistrement de ses résultats. Les transferts et les achats de crédits restent des actions du tableau de bord.
  • Changer le statut d’une action enregistre votre avancement. Ce n’est pas la preuve que la page s’est améliorée.

Voir aussi