Skip to content

dashboard — 仪表盘(5 action) ​

前缀:/api/v1/admin/dashboard/ 权限:全部 DASHBOARD_READ(三角色共享) 代码:src/app/admin/interface/api/dashboard_v1.py + application/usecase/dashboard_stats.py

3.2.1 overview —— 总览 ​

GET /api/v1/admin/dashboard/overview?range=day

Query 参数:

字段类型必填默认说明
rangestring⬜dayday | week | month

响应 data(⚠️ snake_case 新字段 + camelCase P0 存量字段混合):

字段类型说明
rangestring回显口径
total_usersint全量用户数
active_usersint活跃用户数
total_ordersint订单总数
total_revenuefloat累计营收
anomaly_countint异常数
totalAdminsintP0 存量:admin 账号总数
activeAdminsintP0 存量:活跃 admin 数
roleDistributionobjectP0 存量:{super: n, operator: n, it: n}
recentLogins24hintP0 存量:24h 内登录次数
pendingAuditsintP0 存量:待审数

错误码:40201001 非法 range。

注:P0 版本 /overview 被本 v1 superset 覆盖(同路径,注册顺序优先),存量字段合并返回。

3.2.2 user-growth —— 用户增长曲线 ​

GET /api/v1/admin/dashboard/user-growth?range=day&granularity=day

Query 参数:

字段类型必填默认说明
rangestring⬜day时间范围
granularitystring⬜dayday | hour

响应 data:{ "range": ..., "granularity": ..., "series": [ {时间点, 新增数…} ] }

错误码:40201001 非法 range / granularity。

3.2.3 order-stats —— 订单统计 ​

GET /api/v1/admin/dashboard/order-stats?range=day

响应 data:

字段类型说明
rangestring回显口径
totalint订单总数
paidint已支付数
refundedint已退款数
closedint已关闭数
seriesarray时间序列

错误码:40201001 非法 range。

3.2.4 revenue —— 营收统计 ​

GET /api/v1/admin/dashboard/revenue?range=day

响应 data:

字段类型说明
rangestring回显口径
gross_revenuefloat毛营收
net_revenuefloat净营收(扣退款)
refund_amountfloat退款总额
by_channelarray按支付渠道拆分

错误码:40201001 非法 range。

3.2.5 anomalies —— 异常清单 ​

GET /api/v1/admin/dashboard/anomalies?severity=high

Query 参数:

字段类型必填默认说明
severitystring⬜highlow | medium | high

响应 data:{ "severity": ..., "anomalies": [ {severity, …} ] }

错误码:40201001 非法 severity。


通用失败:未登录 → 401 + 40201002;权限不足 → 403 + 40201004(三角色均持有 DASHBOARD_READ,正常不会触发)。