认证与请求头

使用应用 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"`

请求示例

cURL

curl --request GET \
  --url '<BASE_URL>/api/openapi/v1/analytics/dashboard/overview?ds=<ds>&period=<period>' \
  --header 'Authorization: Bearer <API_KEY>'

响应

200 OK

名称	类型	必填	说明	示例
`daily_trend`	`array \| null`	是	`-`	`[{"credits":0,"date":"<string>"}]`
`ds`	`string \| null · date`	是	`-`	`"<string>"`
`last_data_update_time`	`string \| null`	是	来源更新时间，格式 `YYYY-MM-DD HH:mm:ss`，兼容旧日期 `YYYY-MM-DD`；不转换时区，可与 `ds` 不同。	`"2026-09-21 13:00:00"`
`metrics`	`any`	是	`-`	`"<string>"`
`org_id`	`string · uuid`	是	`-`	`"<uuid>"`
`period`	`any`	是	`-`	`"<string>"`
`quota_snapshot`	`OpenapifacadeAnalyticsQuotaSnapshot`	是	`-`	`{"cycle_end_date":"<string>","cycle_start_date":"<string>","next_reset_date":"<string>","remaining_credits":0}`
`quota_snapshot.cycle_end_date`	`string \| null · date`	是	`-`	`"<string>"`
`quota_snapshot.cycle_start_date`	`string \| null · date`	是	`-`	`"<string>"`
`quota_snapshot.next_reset_date`	`string \| null · date`	是	`-`	`"<string>"`
`quota_snapshot.remaining_credits`	`number \| null · double`	是	`-`	`0`
`retention_days`	`integer · int64`	是	`-`	`0`
`subscribed`	`boolean`	是	`-`	`false`
`timezone`	`string`	是	`-`	`"<string>"`

响应示例

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

名称	类型	必填	说明	示例
`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>"
}