Sign in
dashboards

Stream Data

Same results as /data, delivered per widget as each one finishes.

A dashboard is only as fast as its slowest widget when the whole payload has to be assembled first. Streaming lets the tiles that are ready render immediately, which is most of them: widget cost on a real dashboard varies by an order of magnitude.

Access is resolved once, up front — a viewer who may not see the dashboard gets a 404 before the stream opens, not an error event inside it.

get/api/v1/dashboards/{dashboard_id}/data/stream

Path parameters

dashboard_idinteger required

Query parameters

date_windowstring nullable

Narrow every widget to one period, overriding the dashboard's saved default.

Narrow every widget to one period, overriding the dashboard's saved default.

widget_idsinteger[] nullable

Run only these widgets. The layout event then describes just the requested subset, so callers merge it into what they already hold rather than replacing their widget list.

Run only these widgets. The layout event then describes just the requested subset, so callers merge it into what they already hold rather than replacing their widget list.

Headers

authorizationstring nullable
X-API-Keystring nullable

Response

Successful Response

{"stackTrail":"paths:/api/v1/dashboards/{dashboard_id}/data/stream:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

Changed in 1 of the 5 revisions of this API.1