OpenIM Chat Docs

Appearance

2026-05-31-01 仪表盘数值总览（adminx） ​

1. 变更摘要 ​

本次新增 adminx 仪表盘数值总览接口，用于后台首页总量卡片聚合展示：

  • 新增总量聚合接口，统一返回用户/群组/封禁/禁止 IP/下载总量等数值
  • totalUserCount 与 totalGroupCount 复用 OpenIM 统计口径
  • 新增按时区口径统计的 6 个单值：今日/昨日/近十五日注册与登录
  • 为降低跨服务和数据库压力，接口增加 15 秒短缓存
  • 当前版本明确声明 canceledUserCount 与 dissolvedGroupCount 暂不支持

2. 前端影响与动作 ​

  • 如果后台首页当前通过多个接口拼装总量卡片，建议改为单接口 /adminx/statistic/overview_value。
  • 前端建议传入 timezone（如 Asia/Shanghai），以匹配本地自然日统计口径。
  • 若当前页面暂不展示这类卡片，本次可不改。
  • 接口存在 15 秒短缓存，前端应接受秒级延迟，不要用于强实时看板。

动作等级：建议改

3. 接口变更清单 ​

3.1 新增接口 ​

说明路径状态链接
仪表盘数值总览/adminx/statistic/overview_valueActive跳转

3.2 修改接口 ​

无

3.3 删除接口 ​

无

4. 兼容性说明 ​

  • 本次仅新增接口，不改变现有接口请求/响应结构。
  • 新增请求字段 timezone（可选，默认 UTC），以及 6 个统计单值字段，不影响旧字段读取。
  • 原有统计接口（如新增用户数、登录用户数、在线统计）可继续使用。
  • canceledUserCount 与 dissolvedGroupCount 当前返回 null，并通过 capability 字段声明为不支持。
  • allTimeUserCount 与 allTimeGroupCount 当前可返回有效值。

5. 前端对接步骤（最简） ​

  1. 管理后台登录后，继续使用现有管理员 token。
  2. 首页总量模块改为调用 POST /adminx/statistic/overview_value，请求体传 timezone。
  3. 直接消费响应中的 data 字段，不再前端多接口聚合。
  4. 若页面有自动刷新，建议刷新间隔不小于 15 秒。