API 参考 / admin

平台总览计数与系统状态(平台超管)

GET /api/v1/admin/overview · adminOverview

跨组织只读计数(用户按状态 / 近 30 天新增、组织数、项目数按开通状态、活跃会话数)+ 系统状态 (版本 / uptime / DB 连通)。全是控制面库聚合,绝不触碰业务库。要求平台超管。

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

响应字段 · 200

users(必填)
AdminOverviewUsers
users.total(必填)
integer
users.active(必填)
integer
users.suspended(必填)
integer
users.newLast30d(必填)
integer
orgs(必填)
AdminOverviewOrgs
orgs.total(必填)
integer
orgs.newLast30d(必填)
integer
projects(必填)
AdminOverviewProjects
projects.total(必填)
integer
projects.byStatus(必填)
object
sessions(必填)
AdminOverviewSessions
sessions.active(必填)
integer
sessions.last24h(必填)
integer
system(必填)
AdminOverviewSystem
system.version(必填)
string
system.uptimeSeconds(必填)
integer
system.dbHealthy(必填)
boolean
system.mailDeliveryMode(必填)
enum —— 当前真实邮件投递模式;SMTP 已配置时同步直投,否则写入开发 outbox。;取值:smtp / dev_outbox
system.mailQueueStatus(必填)
enum —— 当前发送链路为同步投递,不存在异步邮件队列;不得伪造积压数。;取值:synchronous
support(必填)
AdminOverviewSupport
support.intakePending(必填)
integer —— 仍处 pending 的收件条数(真实 count,不封顶不估算)

错误

请求示例(curl)

curl -X GET "https://你的项目.workflow.games/api/v1/admin/overview" \
  -H "Authorization: Bearer wfp_…"

响应示例

HTTP/1.1 200
{
  "users": {
    "total": 1,
    "active": 1,
    "suspended": 1,
    "newLast30d": 1
  },
  "orgs": {
    "total": 1,
    "newLast30d": 1
  },
  "projects": {
    "total": 1,
    "byStatus": {}
  },
  "sessions": {
    "active": 1,
    "last24h": 1
  },
  "system": {
    "version": "示例文本",
    "uptimeSeconds": 1,
    "dbHealthy": true,
    "mailDeliveryMode": "smtp",
    "mailQueueStatus": "synchronous"
  },
  "support": {
    "intakePending": 1
  }
}

合同真值:OpenAPI 3.1(0.1.0)。

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

Workflow 正在加载…