分页查询成员用量,可按关键词、部门筛选并指定排序字段和排序方向。需传入已发布的数据日期,同一次查询的数据取自同一个数据集。
- Scope:
admin.v1.analytics-usage.read - 权限项:组织全量用量读取(
analytics-usage) - 权限类型:读取
- 接口:GET
/api/openapi/v1/analytics/usage/members
认证与请求头
使用应用 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" |
keyword | query | string | 否 | 搜索关键词 | "<string>" |
department_id | query | string · uuid | 否 | Optional department filter; includes descendants. | "<uuid>" |
sort | query | string | 否 | 排序字段 | "used_credits" |
order | query | string | 否 | 排序方向 | "desc" |
page | query | integer · int64 | 否 | 页码 | 1 |
page_size | query | integer · int64 | 否 | 每页条数 | 20 |
请求示例
响应
200 OK
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
has_more | boolean | 是 | 是否有下一页 | false |
items | array | null | 是 | 记录列表 | - |
last_data_update_time | string | null | 是 | 来源更新时间,格式 YYYY-MM-DD HH:mm:ss,兼容旧日期 YYYY-MM-DD;不转换时区,可与 ds 不同。 | "2026-09-21 13:00:00" |
next_reset_date | string | null · date | 是 | 下次重置日期 | "<string>" |
page | integer · int64 | 是 | 页码 | 0 |
page_size | integer · int64 | 是 | 每页条数 | 0 |
total | integer · int64 | 是 | 总条数 | 0 |
items[] 字段
以下必填性针对对象存在时的子字段;父对象可否省略或为 null,以上层字段表为准。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
avatar | string | null | 是 | 用户头像 |
cycle_quota_credits | number | null · double | 是 | 当前周期额度;无额度时为 null |
cycle_used_credits | number · double | 是 | 当前周期已用积分 |
department_name | string | null | 是 | 部门名称 |
email | string | null | 是 | 邮箱 |
last_used_at | string | null | 是 | 最近使用时间;保留来源时间格式,不推断时区 |
quota_usage_rate | number | null · double | 是 | 额度使用百分比,81.57 表示 81.57%;可超过 100,无额度时为 null |
status | string | null | 是 | 状态 |
used_credits | number · double | 是 | 统计区间已用积分 |
user_id | string · uuid | 是 | 用户 ID |
user_name | string | null | 是 | 用户姓名 |
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 | 否 | 建议使用的规范化值 |