Skip to main content
GET
Get Widget Data

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

range
enum<string> | null

A preset window ending now, by the site picker's id. Give this or explicit start_time/end_time; neither means the site's 24-hour default.

Available options:
30m,
1h,
3h,
6h,
1d,
7d,
14d,
30d,
60d,
90d
start_time
string<date-time> | null
end_time
string<date-time> | null
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 answered for one window.

The per-widget answer of a dashboard data read, addressed by widget id: status says what happened — ok carries the engine's columns/rows/ meta; skipped is a feed or legacy detector widget (a trace list, not an aggregate — read those with list_traces and the feed's filters); error carries a short reason and no rows when the stored spec no longer validates or the engine rejects it — so a broken widget is still a 200 a script can branch on. One widget has no fan-out to protect, so the rows follow run_widget_query: a series comes back whole and every other display returns what the engine returns. truncated is kept for parity with the dashboard read and is always false here. window is the window the rows were answered for — the one to name with any figure.

status
enum<string>
required
Available options:
ok,
skipped,
error
widget
WidgetRef · object
required

The identity of the widget a data read answered, with its dashboard.

window
QueryWindow · object
required

The window a query was actually answered for.

range is the preset id the caller gave (or the default's, when they gave nothing) and None for explicit bounds. clamped is True when the plan's retention pulled start_time forward — the honest reason a caller's window and the answered one differ.

columns
string[] | null
error
string | null
meta
Meta · object | null
rows
any[][] | null
truncated
boolean
default:false