Query Dashboard Data | Confident AI Docs

curl -X POST https://api.confident-ai.com/v1/dashboards/dashboardId/query \
     -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
     -H "Content-Type: application/json" \
     -d '{
  "startTime": "2024-01-01T00:00:00.000Z",
  "endTime": "2024-01-31T23:59:59.999Z",
  "granularity": "day",
  "widgetIds": [
    "WIDGET-ID"
  ]
}'

{
  "success": true,
  "data": {
    "results": [
      {
        "widgetId": "WIDGET-ID",
        "status": "ok",
        "type": "LINE",
        "mode": "TIME_SERIES",
        "kind": "TIME_SERIES",
        "unit": "COUNT",
        "xAxis": {
          "type": "time"
        },
        "series": [
          {
            "key": "Count",
            "name": "Count",
            "color": "BLUE",
            "points": [
              {
                "x": "2024-01-01T00:00:00.000Z",
                "y": 42
              }
            ],
            "lineId": "LINE-ID"
          }
        ]
      }
    ]
  },
  "deprecated": false
}

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.

Path parameters

dashboardIdstringRequired

The id of the dashboard.

Request

Optional time range and widget filter for the dashboard data query. Send {} to use each 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.

widgetIdslist of stringsOptional

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

Indicates if the request was successful.

dataobject

The batch query payload.

deprecatedboolean

Indicates if this endpoint is deprecated.

Path parameters

Headers

Request

Response