Skip to main content
GET
Get the workspace overview dashboard

Authorizations

Authorization
string
header
required

workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens

Headers

akua-context
string

Optional workspace/scope context for the request. Carries a single workspace wire id (ws_…) today. Only needed for broad tokens — a workspace-owned token implies its workspace.

Required string length: 1 - 53
Example:

"ws_j572abc123def456"

Response

Workspace overview dashboard

id
string
required
Required string length: 1 - 55
Example:

"dash_j572abc123def456"

html_url
string<uri>
required

Absolute dashboard URL for this resource. OUTPUT_ONLY.

Maximum string length: 2048
Example:

"https://akua.dev/dashboards/dash_j572abc123def456"

name
string
required
Example:

"Cluster Overview"

description
string | null
required

Optional dashboard description

workspace_id
string
required
Required string length: 1 - 53
purpose
enum<string>
required
Available options:
workspace_overview,
custom
filter_definitions
object[]
required
Maximum array length: 24
default_filter_values
object
required
active_revision_id
string | null
required
Required string length: 1 - 55
widgets
object[]
required

Output-only denormalized widget list for dashboard read models.

created_by
string
required

User ID of the dashboard creator

created_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0
updated_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0
etag
string
required