AI 助手
TRAE 智能问答助手
你好,我是 TRAE 文档问答助手 🎉 你在阅读当前文档的过程中,无论对文档概念的解释,还是文档内容方面的疑问,都可以随时向我提问,我会全力为你解答
推荐问题
TRAE IDE 里最热门的 Skill 是哪些?
如何创建自定义智能体?
如何配置 Rules?
文档反馈

获取活跃成员数

获取指定时间范围内,企业在各客户端的活跃成员数。

所需权限

statistics:read

请求说明

  • 请求方式:GET
  • 请求地址:{域名}/openapi/v1/statistics/active-users

注意事项

时间跨度最长为 180 天。

请求参数

请求头参数

Header 参数 是否必填 描述
Authorization 固定取值为 Bearer {access_token}。关于如何获取访问令牌,参考鉴权

查询参数

参数 类型 是否必填 默认值 描述
start_date string - 开始日期。格式:YYYY-MM-DD。
end_date string - 结束日期。格式:YYYY-MM-DD。
timezone string "Asia/Shanghai" 时区。需使用 IANA 时区名称。

department_id

string

-

目标部门的 ID。若传入该参数,则仅返回该部门的数据。省略则统计整个企业的数据。

部门 ID 可以通过 “获取单个父部门的子部门” 接口或 ”按关键词搜索部门“ 接口获取。

include_subtree

bool

true

是否返回目标部门的所有后代部门的数据:

  • true 或省略:包含目标部门的所有后代部门的数据
  • false:仅包含目标部门的数据

该参数仅在传入 department_id 参数时生效。

响应参数

该接口独有的响应参数如下,参数位于 data 中。通用响应参数参考此文档

参数 类型 描述
total_active_users int64 所有客户端去重后的活跃成员总数。如果同一成员在多个客户端上活跃,只会被计算一次。
ide_active_users int64 TraeCode 中的活跃成员数。
plugin_active_users int64 TraeCode Plugin 中的活跃成员数。
cli_active_users int64 TraeCode CLI 中的活跃成员数。
solo_desktop_code_active_users int64 TraeWork 桌面版 Code 模式中的活跃成员数。
solo_desktop_work_active_users int64 TraeWork 桌面版 Work 模式中的活跃成员数。
solo_web_code_active_users int64 TraeWork 网页版 Code 模式中的活跃成员数。
solo_web_work_active_users int64 TraeWork 网页版 Work 模式中的活跃成员数。

示例

请求示例

curl -X GET "${HOST}/openapi/v1/statistics/active-users?start_date=2026-08-01&end_date=2026-08-15&department_id=20001&include_subtree=false" \
  -H "Authorization: Bearer ${ACCESS_TOKEN}"

响应示例

{
  "code": 0,
  "message": "success",
  "request_id": "req_xxx",
  "data": {
    "total_active_users": 120,
    "ide_active_users": 100,
    "plugin_active_users": 30,
    "cli_active_users": 8,
    "solo_desktop_code_active_users": 5,
    "solo_desktop_work_active_users": 2,
    "solo_web_code_active_users": 3,
    "solo_web_work_active_users": 1
  }
}

错误码

若该接口的请求返回错误码,参考错误码文档进行排查。