API 参考 / research

research 指标字典列表（平台超管）

GET /api/v1/research/metrics · listResearchMetrics

返回版本化指标字典列表（设计稿 r8：19 指标 4 组 Steam 6 / 微信 4 / TapTap 4 / 派生 5）。 口径版本化：每 metric_key 默认返回最新版本；已发布快照引用它当时的版本（钉定），字典后续 修订只新增更高 version 行（旧 version 保留不可改写）。仅平台超管可访问。

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

参数

sourceGroup
string
includeDeprecated
boolean

响应字段 · 200

items（必填）
ResearchMetricListItem[]
items[].definition（必填）
ResearchMetricDefinition
items[].definition.id（必填）
string
items[].definition.metricKey（必填）
string —— 稳定 key（snake_case，如 steam_peak_ccu）
items[].definition.version（必填）
integer —— 口径版本号（同 key 单调递增）
items[].definition.name（必填）
string —— 展示名（如「Steam 同时在线峰值」）
items[].definition.definition（必填）
string —— 口径定义（公式 / 计算规则）
items[].definition.unit（必填）
string —— 单位（players / cny / percent 等）
items[].definition.aggregation（必填）
string —— 聚合方法（peak / sum / avg / latest）
items[].definition.sourceGroup（必填）
enum；取值：steam / wechat / taptap / apple / derived
items[].definition.platforms（必填）
string[] —— 适用平台；空数组 = 全平台
items[].definition.regions（必填）
string[] —— 适用地区；空数组 = 全地区
items[].definition.realOrEstimated（必填）
enum；取值：real / estimated
items[].definition.refreshLatency（必填）
string —— 刷新延迟（每周 / 次日 / 实时）
items[].definition.deprecated（必填）
boolean —— 是否废弃（保留历史引用，不物理删除）
items[].definition.createdAt（必填）
string
items[].definition.updatedAt（必填）
string
items[].isLatest（必填）
boolean —— 本行是该 key 的最新版本

错误

请求示例（curl）

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

响应示例

HTTP/1.1 200
{
  "items": [
    {
      "definition": {
        "id": "018f3c2e-0000-7000-8000-000000000000",
        "metricKey": "示例文本",
        "version": 1,
        "name": "示例标题",
        "definition": "示例文本",
        "unit": "示例文本",
        "aggregation": "示例文本",
        "sourceGroup": "steam",
        "platforms": [],
        "regions": [],
        "realOrEstimated": "real",
        "refreshLatency": "示例文本",
        "deprecated": true,
        "createdAt": "示例文本",
        "updatedAt": "2026-08-01"
      },
      "isLatest": true
    }
  ]
}

合同真值：OpenAPI 3.1（0.1.0）。

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

Workflow 正在加载…