COconfident-ai
Dashboards

Query Widget Data

Changed on

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

post/v1/dashboards/{dashboardId}/widgets/{widgetId}/query

Request

Path parameters

dashboardIdstring required

The id of the dashboard.

widgetIdstring required

The id of the widget.

Request body

startTimestring date-time

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

endTimestring date-time

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

granularity'thirty_minutes' | 'hour' | 'day' | 'week' | 'month'

Bucket size for computed widget data.

Response

The computed data for the requested widget.

successboolean required

Indicates if the request was successful.

deprecatedboolean required

Indicates if this endpoint is deprecated.

Changes