Skip to main content
GET
Get Widget

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

widget_id
string
required

Query Parameters

project_id
string | null

Target project for the request. Required when authenticating with a user session token (a user credential is only meaningful scoped to a project); for an API key it is optional and, if given, must match the key's project.

Response

Successful Response

One saved widget, as stored, with the dashboard it belongs to.

spec is exactly what the create parsed (defaults filled, unknown keys stripped), so what a caller reads is what the engine runs. dashboard_id and dashboard_name let a caller holding only a widget id climb to the dashboard without a second read. Widgets record no creator.

create_time
string<date-time>
required
dashboard_id
string
required
dashboard_name
string
required
display_config
any
required
id
string
required
spec
any
required
title
string
required
type
string
required
update_time
string<date-time>
required