Documentação

Referência para Agentes, MCP & API

Execute relatórios IA SEO do seu site, REST API ou MCP, com uma chave para tudo em qualquer plano pago.

Primeira vez aqui? A página para desenvolvedores explica o modelo de acesso antes da referência de endpoints. Ler a visão geral da API de relatório de SEO

Autenticação

Todas as solicitações requerem um token Bearer. Chaves API estão disponíveis em planos pagos; crie uma nas configurações da sua conta. Cada novo site usa um dos créditos do seu plano, que são reiniciados no primeiro dia de cada mês (UTC) e nunca são acumulados.

Header· http

Authorization: Bearer sr__live_your_api_key

Exemplo de Solicitação

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"}'

Pontos de Extremidade da API REST

URL base: https://seoreport.dev

POST/api/v1/reportsCrie um novo relatório ou reutilize um existente. Adicione "forceRerun": true para escanear o site novamente.

GET/api/v1/reports/:idObtenha o status do relatório e seções.

GET/api/v1/reports/:id/resultLeia o payload completo do resultado.

GET/api/v1/reports/:id/download?format=pdf|md|txt|jsonBaixe o relatório renderizado como PDF, Markdown, texto ou JSON

PUT/api/v1/monitorsInicia o monitoramento semanal de um domínio; “enabled”: false pausa-o.

GET/api/v1/monitorsLista os domínios que esta conta monitora.

DELETE/api/v1/monitors?url=Interrompe o monitoramento de um domínio e exclui seus resultados armazenados.

Exemplo de Resposta

response.json· json

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

Como ler o resultado

Quando report.status é completed, o endpoint de resultado retorna o relatório completo. As descobertas ficam na entrada de report.view.sections cuja chave é full_findings, em detail.findings. Os campos de texto são escritos no idioma do relatório.

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: O endereço auditado. Um redirecionamento dentro do mesmo domínio é seguido, então ele pode ser diferente da URL que você enviou.
report.auditedAt: Quando a auditoria foi feita, como carimbo de data/hora ISO 8601.
report.score.overall: A pontuação geral, de 0 a 100.
report.view.sections[].state: Indica se o conteúdo da seção está disponível. O detail é null até que o estado seja ready.
findings[].status: O resultado da descoberta: fail, warn, pass, info.
findings[].areaLabel: A parte do site a que a descoberta se refere.
findings[].title: A descoberta, em uma linha.
findings[].whyItMatters: Por que a descoberta importa para a visibilidade em buscas e em IA.
findings[].fix: O que mudar. Preenchido nas descobertas com falha ou alerta, vazio nas demais.

O resultado traz mais campos do que estes. Baseie sua integração nos campos listados aqui; os demais não são documentados e podem mudar.