Skip to main content

查询部门用量

查询指定部门及其下级部门在某个数据日期和统计周期下的用量汇总。不传部门标识时返回组织根层级的汇总结果。

  • Scope:admin.v1.analytics-usage.read
  • 权限项:组织全量用量读取(analytics-usage)
  • 权限类型:读取
  • 接口:GET/api/openapi/v1/analytics/usage/departments

认证与请求头

使用应用 API Key 调用。当前接口只校验上方独立 Scope;读取、管理与执行权限互不隐含。
名称位置类型必填说明示例
Authorizationheaderstring是应用 API Key,使用 Bearer 方式传递。Bearer qwk_***
X-Request-Idheaderstring否可选的调用追踪标识;未传入时由服务端生成。req-20260831-001

请求参数

名称位置类型必填说明示例
dsquerystring · date必填数据日期"<string>"
periodquerystring必填统计周期"cycle"
department_idqueryarray | null必填Repeated department UUIDs, unique and nonzero; includes descendants.["<string>"]

请求示例

curl --request GET \
  --url 'https://dev-develop.dev-vpc.qwenwork.cn/api/openapi/v1/analytics/usage/departments?ds=<ds>&period=<period>&department_id=<department_id>' \
  --header 'Authorization: Bearer <API_KEY>'

响应

200 OK

名称类型必填说明示例
itemsarray | null是记录列表-
last_data_update_timestring是来源更新时间,格式 YYYY-MM-DD HH:mm:ss,兼容旧日期 YYYY-MM-DD;不转换时区,可与 ds 不同。"2026-09-21 13:00:00"

items[] 字段

以下必填性针对对象存在时的子字段;父对象可否省略或为 null,以上层字段表为准。
字段类型必填说明
department_idstring · uuid是部门 ID;标识本条用量统计所属部门
member_countinteger · int64是成员数量
used_creditsnumber · double是统计区间已用积分
{
  "items": [
    {
      "department_id": "<uuid>",
      "member_count": 0,
      "used_credits": 0
    }
  ],
  "last_data_update_time": "2026-09-21 13:00:00"
}

default Flat business error

名称类型必填说明示例
codestring否Stable business error code"<string>"
detailstring是Human-readable error description"<string>"
detailsOpenapiErrorDetails否错误详情-
errorstring是Stable HTTP error type"<string>"

details 字段

以下必填性针对对象存在时的子字段;父对象可否省略或为 null,以上层字段表为准。
字段类型必填说明
fieldstring否校验失败的请求字段
reasonstring否校验失败的原因代码
suggestionstring否建议使用的规范化值
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}