Skip to main content
POST
Create dashboard widget

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"

idempotency-key
string

Optional caller-supplied idempotency key. Any non-empty key up to 64 characters is accepted. Endpoint-specific documentation describes how the key is used.

Required string length: 1 - 64
Example:

"create-prod-2026-05-07"

Path Parameters

id
string
required
Required string length: 1 - 55

Body

application/json
snippet_id
string
required
Required string length: 1 - 54
col_span
required
Available options:
1
title
string
Maximum string length: 100
display_type
enum<string> | null

Controls how the snippet result is rendered in dashboard widgets

Available options:
table,
stat,
json,
logs,
timeseries,
null
position
integer

Response

Dashboard widget created

id
string
required
Required string length: 1 - 54
dashboard_id
string
required
Required string length: 1 - 55
widget_type
enum<string>
required

Dashboard widget descriptor type. snippet is the first concrete type; future agent-authored widgets extend this field.

Available options:
snippet
snippet_id
string
required
Required string length: 1 - 54
title
string | null
required
position
integer
required
col_span
required
Available options:
1
display_type
enum<string> | null
required

Controls how the snippet result is rendered in dashboard widgets

Available options:
table,
stat,
json,
logs,
timeseries,
null
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