ドキュメント

エージェント、MCP & APIのリファレンス

ウェブサイト、REST API、または MCP から AI SEO レポートを実行し、すべての有料プランで1つのキーを使用します。

はじめての方へ。開発者向けページでは、エンドポイントの詳細に入る前にアクセスモデルを説明しています。 SEOレポートAPIの概要を読む

認証

すべてのリクエストには Bearer トークンが必要です。API キーは有料プランで利用可能です。アカウント設定で作成してください。各新しいサイトはプランのクレジットを1つ使用し、クレジットは各月の1日（UTC）にリセットされ、ロールオーバーしません。

Header· http
Authorization: Bearer sr__live_your_api_key

例リクエスト

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 エンドポイント

ベース URL： https://seoreport.dev

POST/api/v1/reports
GET/api/v1/reports/:id
GET/api/v1/reports/:id/result
GET/api/v1/reports/:id/download?format=pdf|md|txt|json
PUT/api/v1/monitors
GET/api/v1/monitors
DELETE/api/v1/monitors?url=

例の応答

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

結果の読み方

report.status が completed になると、結果エンドポイントはレポート全体を返します。所見は、report.view.sections のうちキーが full_findings のエントリの detail.findings にあります。テキストフィールドはレポートの言語で書かれています。

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
実際に監査したアドレスです。同じドメイン内のリダイレクトは追跡されるため、送信した URL と異なる場合があります。
report.auditedAt
監査を実行した日時（ISO 8601 タイムスタンプ）。
report.score.overall
0〜100 の総合スコア。
report.view.sections[].state
セクションの内容が利用可能かどうかを示します。状態が ready になるまで detail は null です。
findings[].status
所見の判定：fail, warn, pass, info。
findings[].areaLabel
所見が関係するサイトの領域。
findings[].title
所見を 1 行で表したもの。
findings[].whyItMatters
その所見が検索と AI での可視性に影響する理由。
findings[].fix
変更すべき内容。不合格と警告の所見では値が入り、それ以外では空です。

結果にはこれ以外のフィールドも含まれます。ここに記載したフィールドを使って実装してください。それ以外は文書化されておらず、変更される可能性があります。

エージェントを MCP URL に接続してください。