Skip to main content

查询成员用量

分页查询成员用量,可按关键词、部门筛选并指定排序字段和排序方向。需传入已发布的数据日期,同一次查询的数据取自同一个数据集。

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

认证与请求头

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

请求参数

名称位置类型必填说明示例
dsquerystring · date必填数据日期"<string>"
periodquerystring必填统计周期"cycle"
keywordquerystring否搜索关键词"<string>"
department_idquerystring · uuid否Optional department filter; includes descendants."<uuid>"
sortquerystring否排序字段"used_credits"
orderquerystring否排序方向"desc"
pagequeryinteger · int64否页码1
page_sizequeryinteger · int64否每页条数20

请求示例

curl --request GET \
  --url 'https://dev-develop.dev-vpc.qwenwork.cn/api/openapi/v1/analytics/usage/members?ds=<ds>&period=<period>&keyword=<keyword>&department_id=<department_id>&sort=used_credits&order=desc&page=1&page_size=20' \
  --header 'Authorization: Bearer <API_KEY>'

响应

200 OK

名称类型必填说明示例
has_moreboolean是是否有下一页false
itemsarray | null是记录列表-
last_data_update_timestring | null是来源更新时间,格式 YYYY-MM-DD HH:mm:ss,兼容旧日期 YYYY-MM-DD;不转换时区,可与 ds 不同。"2026-09-21 13:00:00"
next_reset_datestring | null · date是下次重置日期"<string>"
pageinteger · int64是页码0
page_sizeinteger · int64是每页条数0
totalinteger · int64是总条数0

items[] 字段

以下必填性针对对象存在时的子字段;父对象可否省略或为 null,以上层字段表为准。
字段类型必填说明
avatarstring | null是用户头像
cycle_quota_creditsnumber | null · double是当前周期额度;无额度时为 null
cycle_used_creditsnumber · double是当前周期已用积分
department_namestring | null是部门名称
emailstring | null是邮箱
last_used_atstring | null是最近使用时间;保留来源时间格式,不推断时区
quota_usage_ratenumber | null · double是额度使用百分比,81.57 表示 81.57%;可超过 100,无额度时为 null
statusstring | null是状态
used_creditsnumber · double是统计区间已用积分
user_idstring · uuid是用户 ID
user_namestring | null是用户姓名
{
  "has_more": false,
  "items": [
    {
      "avatar": "<string>",
      "cycle_quota_credits": 0,
      "cycle_used_credits": 0,
      "department_name": "<string>",
      "email": "<string>",
      "last_used_at": "<string>",
      "quota_usage_rate": 0,
      "status": "<string>",
      "used_credits": 0,
      "user_id": "<uuid>",
      "user_name": "<string>"
    }
  ],
  "last_data_update_time": "2026-09-21 13:00:00",
  "next_reset_date": "<string>",
  "page": 0,
  "page_size": 0,
  "total": 0
}

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>"
}