API 参考 / research

research 市场快照列表(平台超管)

GET /api/v1/research/snapshots · listResearchSnapshots

返回市场快照列表(按周倒序),可按状态过滤。仅平台超管可访问。 每周唯一版本(week_key UNIQUE);发布后不可变。含覆盖摘要 / 质量报告 / 发布人 / 时间。

本接口要求浏览器会话。Bearer API Token 无法调用——Token 的生命周期管理必须在网页端完成。

参数

status
string
limit
integer

响应字段 · 200

items(必填)
ResearchMarketSnapshot[]
items[].id(必填)
string
items[].weekKey(必填)
string —— ISO 8601 周编号(每周唯一)
items[].status(必填)
enum —— draft 草稿、blocked 阻断(未满足发布门槛)、published 已发布(不可变)、superseded 被取代或指针回滚后不再 current。;取值:draft / blocked / published / superseded
items[].coverageSummary(必填)
object —— 覆盖摘要({source: {records, coverage, exempt};缺源附豁免标注)
items[].metricVersions(必填)
object —— 发布时钉定的字典版本(快照复现用)
items[].ontologyVersions(必填)
object —— 发布时钉定的本体版本
items[].evidenceIds(必填)
string[] —— 钉定的 Evidence id 集合(重放同一证据集合)
items[].qualityReport(必填)
object —— 质量报告(阻断项 / 警告项 / 覆盖度 / 数据质量披露)
items[].publishedBy
string —— 发布人 id(published 时填)
items[].publishedAt
string
items[].createdAt(必填)
string
items[].updatedAt(必填)
string

错误

请求示例(curl)

curl -X GET "https://你的项目.workflow.games/api/v1/research/snapshots?status=…&limit=…" \
  -H "Authorization: Bearer wfp_…"

响应示例

HTTP/1.1 200
{
  "items": [
    {
      "id": "018f3c2e-0000-7000-8000-000000000000",
      "weekKey": "示例文本",
      "status": "draft",
      "coverageSummary": {},
      "metricVersions": {},
      "ontologyVersions": {},
      "evidenceIds": [
        "018f3c2e-0000-7000-8000-000000000000"
      ],
      "qualityReport": {},
      "createdAt": "示例文本",
      "updatedAt": "2026-08-01"
    }
  ]
}

合同真值:OpenAPI 3.1(0.1.0)。

相关:Agent 接入指南 · 使用指南 · API 参考索引

Workflow 正在加载…