Get dashboard widget

Returns a single dashboard widget.

GET /dashboards/{id}/widgets/{wgt_id}

Get dashboard widget

cURL

curl --request GET \
  --url https://api.akua.dev/v1/dashboards/{id}/widgets/{wgt_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "dashboard_id": "<string>",
  "snippet_id": "<string>",
  "position": 123,
  "created_at": 1,
  "updated_at": 1,
  "etag": "<string>"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string · required

Required string length: 1 - 55

wgt_id · string · required

Required string length: 1 - 54

Response

200

application/json

Dashboard widget details

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

position · integer · required

col_span · Option 1 · enum<number> Option 2 · enum<number> Option 3 · enum<number> Option 4 · enum<number> · 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, 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