查询成员用量
将 <BASE_URL> 替换为所在企业环境的 API 域名。
- 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 |
请求示例
cURL
curl --request GET \
--url '<BASE_URL>/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_more | boolean | 是 | - | false |
items | array | null | 是 | - | [{"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 | 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 |
响应示例
{
"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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
code | string | 否 | Stable business error code | "<string>" |
detail | string | 是 | Human-readable error description | "<string>" |
details | OpenapiErrorDetails | 否 | - | {"field":"<string>","reason":"<string>","suggestion":"<string>"} |
details.field | string | 否 | Request field that failed validation | "<string>" |
details.reason | string | 否 | Stable validation failure reason | "<string>" |
details.suggestion | string | 否 | Suggested normalized value | "<string>" |
error | string | 是 | Stable HTTP error type | "<string>" |
响应示例
{
"code": "<string>",
"detail": "<string>",
"details": {
"field": "<string>",
"reason": "<string>",
"suggestion": "<string>"
},
"error": "<string>"
}