cdnca

API reference

/v1/admin/dashboard

1 operations

← All groups · First call? Read the tutorial: auth, permissions, requests and responses, common failures

MethodPathSummaryAuth
GET/v1/admin/dashboardRead the platform administrator dashboardSession

Contract file：api/control-dashboard.openapi.yaml

Operation details

GET /v1/admin/dashboard

Read the platform administrator dashboard

operationId
getAdminDashboard
Auth
  • Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
Required permissions

All of：platform.admin

Description (from the contract)

Requires a live platform session and platform.admin. The calendar window is constructed in timezone, converted to a left-closed, right-open UTC window, and must remain hour aligned and no longer than 31 local calendar days (745 elapsed hours across a fall-back). Every query parameter is required, single-valued, and strict; unknown parameters and tenant_id are rejected.

Parameters

getAdminDashboard Parameters
NameInTypeRequiredDescription
rangequerystring: seven_days / thirty_days / previous_monthYesPlatform calendar range in the requested timezone.
timezonequerystringYesIANA timezone name other than Local. Calendar boundaries converted to UTC must be hour aligned; zones with a non-hour boundary offset are rejected rather than rounded.
site_idquerystring(uuid)NoOptional canonical site UUID for ClickHouse drill-down; tenant scope remains session-derived.
node_idquerystring(uuid)NoOptional canonical node UUID for ClickHouse drill-down; tenant scope remains session-derived.
X-Request-IDheaderstringNoOptional safe correlation ID; invalid values are replaced.

Responses

getAdminDashboard Responses
StatusDescription
200Version 2 platform dashboard snapshot.

Fields：dashboard_version: integer meta: DashboardMeta accounts: object | UnavailableSection subscriptions: object | UnavailableSection billing: object | UnavailableSection resources: object | UnavailableSection operations: object | UnavailableSection operation_charts?: object | UnavailableSection entitlement: object | UnavailableSection node_health: object | UnavailableSection analytics_health: object | UnavailableSection account_security: object | UnavailableSection network: object | UnavailableSection analytics: object | UnavailableSection

400dashboard_invalid_request
401dashboard_authentication_required
403dashboard_scope_forbidden or dashboard_permission_denied
408dashboard_request_cancelled
500dashboard_internal_error
502dashboard_response_too_large
503dashboard_storage_unavailable; no zero-value data is substituted.
504dashboard_query_timeout

What to do on failure

  • 400 Fix the parameters or body per the field list; do not retry unchanged.
  • 401 Check the credential format and whether it expired or was rotated.
  • 403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.
  • 500 Outcome unknown: read back by ID or list first, then decide whether to retry with the original Idempotency-Key.
  • 503 A dependency is unavailable: retry later with the original Idempotency-Key.

↑ Back to list