Skip to main content

查询组织统计看板

读取组织统计看板的核心指标、用量趋势和额度快照。需传入已发布的数据日期，响应同时返回数据保留天数和统计时区。

  • Scope：admin.v1.analytics-dashboard.read
  • 权限项：综合看板读取（analytics-dashboard）
  • 权限类型：读取
  • 接口：GET/api/openapi/v1/analytics/dashboard/overview

认证与请求头

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

请求参数

名称位置类型必填说明示例
dsquerystring · date必填数据日期"<string>"
periodquerystring必填统计周期"cycle"

请求示例

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

响应

200 OK

名称类型必填说明示例
daily_trendarray ｜ null是积分消耗趋势-
dsstring ｜ null · date是数据日期"<string>"
last_data_update_timestring ｜ null是来源更新时间，格式 YYYY-MM-DD HH:mm:ss，兼容旧日期 YYYY-MM-DD；不转换时区，可与 ds 不同。"2026-09-21 13:00:00"
metricsany是用量指标-
org_idstring · uuid是组织 ID"<uuid>"
periodany是统计周期-
quota_snapshotOpenapifacadeAnalyticsQuotaSnapshot是额度快照-
retention_daysinteger · int64是数据保留天数0
subscribedboolean是是否有有效订阅或统计数据false
timezonestring是时区"<string>"

daily_trend[] 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
creditsnumber · double是积分用量，保留上游精度
datestring · date是统计日期

metrics 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
active_member_countinteger · int64是活跃成员数
active_member_ratenumber ｜ null · double是活跃成员占比
daily_average_creditsnumber · double是日均消耗积分
seat_countinteger · int64是席位数
total_credits_usednumber · double是累计消耗积分

period 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
daysinteger · int64是统计天数
end_datestring · date是统计结束日期
keystring是统计周期标识
labelstring是统计周期显示名称
start_datestring · date是统计开始日期

quota_snapshot 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
cycle_end_datestring ｜ null · date是周期结束日期
cycle_start_datestring ｜ null · date是周期开始日期
next_reset_datestring ｜ null · date是下次重置日期
remaining_creditsnumber ｜ null · double是剩余积分额度
{
  "daily_trend": [
    {
      "credits": 0,
      "date": "<string>"
    }
  ],
  "ds": "<string>",
  "last_data_update_time": "2026-09-21 13:00:00",
  "metrics": "<string>",
  "org_id": "<uuid>",
  "period": "<string>",
  "quota_snapshot": {
    "cycle_end_date": "<string>",
    "cycle_start_date": "<string>",
    "next_reset_date": "<string>",
    "remaining_credits": 0
  },
  "retention_days": 0,
  "subscribed": false,
  "timezone": "<string>"
}

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