Skip to main content
POST
Fetch live widget data

Authorizations

Authorization
string
header
required

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

Headers

X-API-Key
string | null

Path Parameters

project_id
string<uuid>
required
report_id
string<uuid>
required

Body

application/json

Request body for fetching live data for one or more widgets.

widget_ids
string<uuid>[]

UUIDs of the widgets to fetch data for. If empty, data is fetched for all widgets on the page.

date_start
string<date> | null

Override start date for data fetching. Falls back to the report's configured date range when null.

date_end
string<date> | null

Override end date for data fetching. Falls back to the report's configured date range when null.

widgets
InlineWidget · object[]

When provided, the API uses these widget definitions directly instead of loading from the database. This allows fetching data for unsaved widgets in the editor.

Response

Successful Response

success
boolean
default:true
data
Data · object | null