COconfident-ai
Dashboards

Query Dashboard Data

Changed on

Fetches computed data for all widgets on a dashboard, or for a provided subset of widget IDs. Request time range fields override widget defaults for this query only.

post/v1/dashboards/{dashboardId}/query

Request

Path parameters

dashboardIdstring required

The id of the dashboard.

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.

widgetIdsstring[]

Optional subset of widget IDs to query. If omitted, all widgets on the dashboard are queried.

Response

The computed data for the requested dashboard widgets.

successboolean required

Indicates if the request was successful.

deprecatedboolean required

Indicates if this endpoint is deprecated.

Changes