Référence de l’API

Générée depuis la spécification OpenAPI 3.1 que nos tests valident à chaque réponse : ce qui est décrit ici est ce que l’API rend.

Compte

Le jeton, son équipe, son offre et sa consommation.

• GET /v1/me Décrire le jeton courant
• GET /v1/usage Lire les débits et les quotas de l’offre
• GET /v1/operations Lister les opérations en cours

Projets

Les projets (sites suivis dans le temps) et leur bilan de santé.

• GET /v1/projects Lister les projets
• POST /v1/projects Créer un projet
• GET /v1/projects/{project} Lire un projet
• PATCH /v1/projects/{project} Modifier un projet
• DELETE /v1/projects/{project} Supprimer un projet
• GET /v1/projects/{project}/scorecard Lire le bilan de santé

Campagnes

Les configurations de crawl réutilisables et leur planification.

• GET /v1/projects/{project}/campaigns Lister les campagnes d’un projet
• POST /v1/projects/{project}/campaigns Créer une campagne
• GET /v1/campaigns/{campaign} Lire une campagne
• PATCH /v1/campaigns/{campaign} Modifier une campagne
• DELETE /v1/campaigns/{campaign} Supprimer une campagne

Crawls

Les crawls exécutés et leurs résultats : anomalies, pages, rapports.

• GET /v1/projects/{project}/crawls Lister les crawls d’un projet
• GET /v1/crawls/{crawl} Lire un crawl
• GET /v1/crawls/{crawl}/issues Lister les occurrences d’anomalies
• GET /v1/crawls/{crawl}/issues/summary Résumer les anomalies
• GET /v1/crawls/{crawl}/pages Lister les pages crawlées
• GET /v1/crawls/{crawl}/pages/by-url Lire une page par son URL
• GET /v1/crawls/{crawl}/pagespeed Lire les résultats PageSpeed
• GET /v1/crawls/{crawl}/geo Lire le rapport de préparation GEO
• GET /v1/crawls/{crawl}/accessibility Lire le rapport d’accessibilité
• GET /v1/crawls/{crawl}/eeat Lire le socle de confiance
• GET /v1/crawls/{crawl}/structure Lire le rapport de maillage interne
• GET /v1/crawls/{crawl}/compare Comparer à un crawl de référence
• POST /v1/campaigns/{campaign}/crawls Lancer un crawl
• POST /v1/crawls/{crawl}/stop Arrêter un crawl

Recommandations

Les recommandations IA, globales et par page.

• GET /v1/projects/{project}/recommendations Lire les recommandations IA
• POST /v1/projects/{project}/recommendations Générer les recommandations IA

Exports

Le rapport PDF et le classeur Excel d’un crawl, générés en tâche de fond.

• POST /v1/crawls/{crawl}/exports Demander l’export d’un crawl
• GET /v1/exports/{export} Lire un export
• GET /v1/exports/{export}/download Télécharger un export

Modules

Les modules hors score de santé (positions, Search Console, backlinks, sécurité, journaux). Ils portent une tendance, jamais une note.

• GET /v1/projects/{project}/positions Lire le suivi de positions
• POST /v1/projects/{project}/tracked-keywords Suivre des mots-clés
• POST /v1/projects/{project}/tracked-keywords/untrack Arrêter le suivi de mots-clés
• POST /v1/projects/{project}/tracked-keywords/pause Suspendre des mots-clés suivis
• POST /v1/projects/{project}/tracked-keywords/resume Reprendre des mots-clés suivis
• POST /v1/projects/{project}/tracked-keywords/check Vérifier un mot-clé maintenant
• GET /v1/projects/{project}/search-console Lire les données Search Console
• GET /v1/projects/{project}/backlinks Lire le résumé du profil de liens
• GET /v1/projects/{project}/security Lire les signaux de sécurité
• GET /v1/projects/{project}/logs Lire l’analyse des journaux serveur

Webhooks

Les événements sortants signés (crawl terminé, export prêt, recommandations prêtes, signal détecté). Gérés par les owners et admins de l’équipe.

• GET /v1/webhooks Lister les webhooks
• POST /v1/webhooks Créer un webhook
• GET /v1/webhooks/{webhook} Lire un webhook
• PATCH /v1/webhooks/{webhook} Modifier un webhook
• DELETE /v1/webhooks/{webhook} Supprimer un webhook
• POST /v1/webhooks/{webhook}/rotate-secret Renouveler le secret de signature
• POST /v1/webhooks/{webhook}/test Envoyer un événement de test
• GET /v1/webhooks/{webhook}/deliveries Lister les livraisons