文档

参考代理, MCP & API

从您的网站、REST API 或 MCP 运行 AI SEO 报告，任何付费计划均可使用单一密钥。

第一次使用？开发者页面会先讲清访问模型，然后再进入端点参考。阅读 SEO 报告 API 概览

身份验证

所有请求都需要 Bearer 令牌。API 密钥仅在付费套餐中提供；请在账户设置中创建。每个新站点使用套餐中的 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创建新报告或重用现有报告。添加 "forceRerun": true 可改为重新扫描网站。

GET/api/v1/reports/:id获取报告状态和章节。.

GET/api/v1/reports/:id/result读取完整结果负载。.

GET/api/v1/reports/:id/download?format=pdf|md|txt|json将渲染后的报告下载为 PDF、Markdown、文本或 JSON。

PUT/api/v1/monitors开始对域名进行每周监控；"enabled": false 会暂停它。

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: 用一行文字概括该发现。
findings[].whyItMatters: 该发现为何影响搜索和 AI 可见性。
findings[].fix: 需要修改的内容。失败和警告类发现会填写此字段，其他发现为空。

结果包含的字段不止这些。请基于此处列出的字段进行开发；其他字段未写入文档，可能会变化。

参考 代理, MCP & API