Dokumentation.

Referenz für Agenten, MCP & API

KI-SEO-Berichte von Ihrer Website, REST API oder MCP ausführen, mit einem Schlüssel für alles auf jedem kostenpflichtigen Plan.

Neu hier? Die Entwicklerübersicht erklärt das Zugriffsmodell, bevor du zur Endpunkt-Referenz kommst. SEO-Bericht API im Überblick

Authentifizierung.

Alle Anfragen erfordern ein Bearer-Token. API-Schlüssel sind in kostenpflichtigen Plänen verfügbar; erstellen Sie einen in Ihren Kontoeinstellungen. Jede neue Website verbraucht einen der Credits Ihres Plans; Credits werden am ersten Tag jedes Monats (UTC) zurückgesetzt und nie übertragen.

Header· http

Authorization: Bearer sr__live_your_api_key

Beispielanfrage.

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 Endpunkte.

Basis URL: https://seoreport.dev

POST/api/v1/reportsErstelle einen neuen Bericht oder verwende einen bestehenden. Mit "forceRerun": true wird die Website stattdessen neu gescannt.

GET/api/v1/reports/:idErhalte Berichtstatus und Abschnitte.

GET/api/v1/reports/:id/resultLese die vollständige Ergebnis-Payload.

GET/api/v1/reports/:id/download?format=pdf|md|txt|jsonLaden Sie den gerenderten Bericht als PDF, Markdown, Text oder JSON herunter.

PUT/api/v1/monitorsStartet das wöchentliche Monitoring für eine Domain; „enabled“: false pausiert es.

GET/api/v1/monitorsListet die Domains auf, die dieses Konto überwacht.

DELETE/api/v1/monitors?url=Stoppt das Monitoring einer Domain und löscht ihre gespeicherten Ergebnisse.

Beispielantwort

response.json· json

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

Das Ergebnis lesen

Wenn report.status den Wert completed hat, liefert der Ergebnis-Endpunkt den vollständigen Bericht. Die Feststellungen stehen im Eintrag von report.view.sections mit dem Schlüssel full_findings, unter detail.findings. Textfelder sind in der Sprache des Berichts verfasst.

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: Die geprüfte Adresse. Eine Weiterleitung innerhalb derselben Domain wird verfolgt, daher kann sie von der gesendeten URL abweichen.
report.auditedAt: Zeitpunkt der Prüfung als ISO-8601-Zeitstempel.
report.score.overall: Die Gesamtpunktzahl von 0 bis 100.
report.view.sections[].state: Gibt an, ob der Inhalt des Abschnitts verfügbar ist. detail ist null, bis der Status ready lautet.
findings[].status: Das Ergebnis der Feststellung: fail, warn, pass, info.
findings[].areaLabel: Der Bereich der Website, den die Feststellung betrifft.
findings[].title: Die Feststellung in einer Zeile.
findings[].whyItMatters: Warum die Feststellung für die Sichtbarkeit in Suche und KI wichtig ist.
findings[].fix: Was zu ändern ist. Bei fehlgeschlagenen Feststellungen und Warnungen ausgefüllt, bei allen anderen leer.

Das Ergebnis enthält mehr Felder als diese. Bauen Sie auf den hier aufgeführten Feldern auf; die übrigen sind nicht dokumentiert und können sich ändern.