Query Widget Data

Fetches computed data for one widget. Request time range fields override widget defaults for this query only.

Path parameters

dashboardIdstringRequired
The id of the dashboard.
widgetIdstringRequired
The id of the widget.

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Request

Optional time range override for the widget data query. Send {} to use the widget’s saved/default time range.

startTimestringOptionalformat: "date-time"

ISO 8601 start time for the query range. Must be provided with endTime.

endTimestringOptionalformat: "date-time"

ISO 8601 end time for the query range. Must be provided with startTime.

granularityenumOptional
Optional bucket granularity override for the query.

Response

The computed data for the requested widget.
successboolean
Indicates if the request was successful.
dataobject
The computed widget data.
deprecatedboolean
Indicates if this endpoint is deprecated.