Get Dashboard | Confident AI Docs

{
  "success": true,
  "data": {
    "dashboard": {
      "id": "DASHBOARD-ID",
      "name": "Production Overview",
      "description": null,
      "private": false,
      "projectId": "PROJECT-ID",
      "userId": null,
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "widgets": [
        {
          "id": "WIDGET-ID",
          "name": "Trace Count",
          "description": null,
          "type": "LINE",
          "unit": "COUNT",
          "mode": "TIME_SERIES",
          "bucketMode": {},
          "dimension": {},
          "topK": {},
          "startTime": null,
          "endTime": null,
          "layout": {
            "x": 0,
            "y": 0,
            "w": 6,
            "h": 2
          },
          "lines": [
            {
              "id": "LINE-ID",
              "name": "Count",
              "color": "BLUE",
              "dataModel": "TRACE",
              "aggregation": "COUNT",
              "filters": {},
              "extraQueryParams": {}
            }
          ]
        }
      ]
    }
  },
  "deprecated": false
}

Retrieves a single dashboard with embedded widget configurations and lines. This endpoint does not compute widget data; use a query endpoint for rendered data.

Path parameters

dashboardIdstringRequired

The id of the dashboard.

Response

The requested dashboard with embedded widget configurations.

successboolean

Indicates if the request was successful.

dataobject

The dashboard, including its widget configurations.

deprecatedboolean

Indicates if this endpoint is deprecated.

$	curl https://api.confident-ai.com/v1/dashboards/dashboardId \
>	-H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

Path parameters

Headers

Response