查询指定部门及其下级部门在某个数据日期和统计周期下的用量汇总。不传部门标识时返回组织根层级的汇总结果。
- Scope:
admin.v1.analytics-usage.read - 权限项:组织全量用量读取(
analytics-usage) - 权限类型:读取
- 接口:GET
/api/openapi/v1/analytics/usage/departments
认证与请求头
使用应用 API Key 调用。当前接口只校验上方独立 Scope;读取、管理与执行权限互不隐含。
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|---|
Authorization | header | string | 是 | 应用 API Key,使用 Bearer 方式传递。 | Bearer qwk_*** |
X-Request-Id | header | string | 否 | 可选的调用追踪标识;未传入时由服务端生成。 | req-20260831-001 |
请求参数
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|---|
ds | query | string · date | 必填 | 数据日期 | "<string>" |
period | query | string | 必填 | 统计周期 | "cycle" |
department_id | query | array | null | 必填 | Repeated department UUIDs, unique and nonzero; includes descendants. | ["<string>"] |
请求示例
响应
200 OK
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
items | array | null | 是 | 记录列表 | - |
last_data_update_time | string | 是 | 来源更新时间,格式 YYYY-MM-DD HH:mm:ss,兼容旧日期 YYYY-MM-DD;不转换时区,可与 ds 不同。 | "2026-09-21 13:00:00" |
items[] 字段
以下必填性针对对象存在时的子字段;父对象可否省略或为 null,以上层字段表为准。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
department_id | string · uuid | 是 | 部门 ID;标识本条用量统计所属部门 |
member_count | integer · int64 | 是 | 成员数量 |
used_credits | number · double | 是 | 统计区间已用积分 |
default Flat business error
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
code | string | 否 | Stable business error code | "<string>" |
detail | string | 是 | Human-readable error description | "<string>" |
details | OpenapiErrorDetails | 否 | 错误详情 | - |
error | string | 是 | Stable HTTP error type | "<string>" |
details 字段
以下必填性针对对象存在时的子字段;父对象可否省略或为 null,以上层字段表为准。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
field | string | 否 | 校验失败的请求字段 |
reason | string | 否 | 校验失败的原因代码 |
suggestion | string | 否 | 建议使用的规范化值 |