API 接口文档

左侧选择接口,右侧查看说明与示例。所有对外接口都需要 API Key。

GSC 数据查询接口

按域名查询 Google Search Console 已同步的数据,返回搜索查询和页面表现,包括点击、展示、点击率和排名。

POST /api/admin/gsc/query-by-domain

请求参数

{
  "domain": "example.com",
  "date": "2026-11-02",
  "type": "all",
  "limit": 100
}
domainstring(必填)。域名或网址,如 example.com、https://www.example.com
datestring(可选)。单日,格式 YYYY-MM-DD。不填则使用该网站最新一天的数据
startDate / endDatestring(可选)。日期范围,两个都要填。填写后优先于 date
typestring(可选)。all(默认,同时返回查询和页面)、queries、pages
limitnumber(可选)。每类列表返回条数,按点击降序。默认 100,最多 500

响应示例

{
  "success": true,
  "data": {
    "domain": "example.com",
    "websiteId": 1,
    "siteUrl": "sc-domain:example.com",
    "date": "2026-11-02",
    "summary": {
      "totalClicks": 120,
      "totalImpressions": 3400,
      "avgCtr": 0.035294,
      "avgPosition": 8.42
    },
    "queries": [
      {
        "query": "example keyword",
        "clicks": 20,
        "impressions": 500,
        "ctr": 0.04,
        "position": 6.5
      }
    ],
    "pages": [
      {
        "page": "https://example.com/article",
        "clicks": 15,
        "impressions": 300,
        "ctr": 0.05,
        "position": 7.2
      }
    ]
  }
}

ctr 是点击率小数,0.04 表示 4%。summary.avgPosition 按展示次数加权,和后台概览一致。queries、pages 按点击数从高到低排列。

调用示例

curl -X POST https://youzikuaibao.com.cn/api/admin/gsc/query-by-domain \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <您的密钥>" \
  -d '{"domain": "example.com"}'