Documentation

Référence pour Agents, MCP & API

Exécutez des rapports SEO IA depuis votre site Web, REST API ou MCP, avec une clé unique pour tout sur tout plan payant.

Première visite ? La page développeurs explique le modèle d'accès avant la référence des endpoints. Lire la présentation de l'API de rapport SEO

Authentification

Toutes les requêtes nécessitent un token Bearer. Les clés API sont disponibles sur les plans payants ; créez-en une dans les paramètres de votre compte. Chaque nouveau site utilise un des crédits de votre plan, qui se réinitialisent le premier jour de chaque mois (UTC) et ne sont jamais reportés.

Header· http

Authorization: Bearer sr__live_your_api_key

Exemple de requête

curl· bash

curl -X POST https://seoreport.dev/api/v1/reports \
  -H "Authorization: Bearer sr__live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"url": "example.com"}'

REST API Points de terminaison

URL de base https://seoreport.dev

POST/api/v1/reportsCréez un nouveau rapport ou réutilisez un rapport existant. Ajoutez "forceRerun": true pour analyser à nouveau le site.

GET/api/v1/reports/:idObtenez le statut et les sections du rapport.

GET/api/v1/reports/:id/resultLisez la charge utile complète du résultat.

GET/api/v1/reports/:id/download?format=pdf|md|txt|jsonTéléchargez le rapport rendu en PDF, Markdown, texte ou JSON.

PUT/api/v1/monitorsDémarre la surveillance hebdomadaire d’un domaine ; "enabled" : false le met en pause.

GET/api/v1/monitorsListe les domaines que ce compte surveille.

DELETE/api/v1/monitors?url=Arrête la surveillance d'un domaine et supprime ses résultats stockés.

Réponse d'exemple

response.json· json

{
  "success": true,
  "report": {
    "jobId": "3f6c2a1e-8d4b-4c7a-9e21-5b0d7f4a6c18",
    "status": "completed",
    "targetUrl": "https://example.com"
  },
  "pollAfterMs": 0
}

Lire le résultat

Lorsque report.status vaut completed, le point de terminaison du résultat renvoie le rapport complet. Les constats se trouvent dans l’entrée de report.view.sections dont la clé est full_findings, sous detail.findings. Les champs de texte sont rédigés dans la langue du rapport.

result.json· json

{
  "success": true,
  "report": {
    "jobId": "3f6c2a1e-8d4b-4c7a-9e21-5b0d7f4a6c18",
    "status": "completed",
    "targetUrl": "https://www.example.com/",
    "auditedAt": "2026-10-11T09:14:03.000Z",
    "score": { "overall": 72 },
    "view": {
      "sections": [
        {
          "key": "full_findings",
          "state": "ready",
          "detail": {
            "findings": [
              {
                "status": "fail",
                "areaLabel": "URL signals",
                "title": "Canonical tag missing",
                "whyItMatters": "Canonical tags tell search engines which version of a page should appear in results.",
                "fix": "Add a canonical link element or Link HTTP header pointing to the preferred URL for this page."
              }
            ]
          }
        }
      ]
    }
  }
}

report.targetUrl: L’adresse auditée. Une redirection au sein du même domaine est suivie : elle peut donc différer de l’URL que vous avez envoyée.
report.auditedAt: Date et heure de l’audit, au format ISO 8601.
report.score.overall: Le score global, de 0 à 100.
report.view.sections[].state: Indique si le contenu de la section est disponible. Son detail vaut null tant que l’état n’est pas ready.
findings[].status: Le résultat du constat : fail, warn, pass, info.
findings[].areaLabel: La partie du site concernée par le constat.
findings[].title: Le constat, en une ligne.
findings[].whyItMatters: Pourquoi le constat compte pour la visibilité dans la recherche et l’IA.
findings[].fix: Ce qu’il faut changer. Renseigné pour les constats en échec ou en avertissement, vide pour les autres.

Le résultat contient d’autres champs que ceux-ci. Appuyez-vous sur les champs listés ici ; les autres ne sont pas documentés et peuvent changer.