Read organization statistics. GET /api/openapi/v1/analytics/dashboard/overview, scope admin.v1.analytics-dashboard.read.
- Scope: admin.v1.analytics-dashboard.read
- Permission: Read analytics dashboard (analytics-dashboard)
- Permission type: Read
- Endpoint: GET/api/openapi/v1/analytics/dashboard/overview
Authentication and request headers
Call with an application API key. This endpoint checks only the scope above; read, manage and execute permissions do not imply one another.
| Name | Location | Type | Required | Description | Example |
|---|---|---|---|---|---|
| Authorization | header | string | Yes | Application API key, passed as a Bearer token. | Bearer qwk_*** |
| X-Request-Id | header | string | No | Optional request tracing identifier; generated by the server if omitted. | req-20260831-001 |
Request parameters
| Name | Location | Type | Required | Description | Example |
|---|---|---|---|---|---|
| ds | query | string · date | Required | Data date | "<string>" |
| period | query | string | Required | Reporting period | "cycle" |
Request example
cURL
Responses
200 OK
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| daily_trend | array ｜ null | Yes | Credit usage trend | [{"credits":0,"date":"<string>"}] |
| ds | string ｜ null · date | Yes | Data date | "<string>" |
| last_data_update_time | string ｜ null | Yes | Source update time in YYYY-MM-DD HH:mm:ss format, also accepting the legacy YYYY-MM-DD date format. The time zone is not converted, and the value may differ from ds. | "2026-09-21 13:00:00" |
| metrics | any | Yes | Usage metrics | "<string>" |
| org_id | string · uuid | Yes | Organization ID | "<uuid>" |
| period | any | Yes | Reporting period | "<string>" |
| quota_snapshot | OpenapifacadeAnalyticsQuotaSnapshot | Yes | Quota snapshot | {"cycle_end_date":"<string>","cycle_start_date":"<string>","next_reset_date":"<string>","remaining_credits":0} |
| quota_snapshot.cycle_end_date | string ｜ null · date | Yes | Cycle end date | "<string>" |
| quota_snapshot.cycle_start_date | string ｜ null · date | Yes | Cycle start date | "<string>" |
| quota_snapshot.next_reset_date | string ｜ null · date | Yes | Next reset date | "<string>" |
| quota_snapshot.remaining_credits | number ｜ null · double | Yes | Available credits | 0 |
| retention_days | integer · int64 | Yes | Data retention in days | 0 |
| subscribed | boolean | Yes | Whether a valid subscription or usage data is available | false |
| timezone | string | Yes | Time zone | "<string>" |
default Flat business error
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| code | string | No | Stable business error code | "<string>" |
| detail | string | Yes | Human-readable error description | "<string>" |
| details | OpenapiErrorDetails | No | Error details | {"field":"<string>","reason":"<string>","suggestion":"<string>"} |
| details.field | string | No | Request field that failed validation | "<string>" |
| details.reason | string | No | Stable validation failure reason | "<string>" |
| details.suggestion | string | No | Suggested normalized value | "<string>" |
| error | string | Yes | Stable HTTP error type | "<string>" |