Skip to main content
GET
Get Dashboard Data

Authorizations

Authorization
string
header
required

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

Path Parameters

dashboard_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

A dashboard's query widgets, up to the per-request cap, answered for one window.

Widgets keep the dashboard's order. window is the window they were all answered for — the one to name alongside any figure taken from here.

dashboard
DashboardSummary · object
required

The dashboard fields shared by the list and detail reads.

creator is the created-by user's display name (or email), resolved by the internal route; it is None when the creating account was deleted.

failed
integer
required
queried
integer
required
skipped
integer
required
widgets
DashboardWidgetData · object[]
required
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.