List Dashboards

GEThttps://api.confident-ai.com/v1/dashboards

Lists dashboard overviews in your Confident AI project — metadata and widget counts only. Widget configurations are returned by the dashboard detail endpoint, and computed widget data by the query endpoints.

GET/v1/dashboards

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

200

{
  "success": true,
  "data": {
    "dashboards": [
      {
        "id": "DASHBOARD-ID",
        "name": "Production Overview",
        "description": null,
        "private": false,
        "projectId": "PROJECT-ID",
        "userId": null,
        "widgetCount": 2,
        "createdAt": "2024-01-01T00:00:00.000Z",
        "updatedAt": "2024-01-01T00:00:00.000Z"
      }
    ]
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Response

The dashboard overviews in your project.

successboolean
Indicates if the request was successful.
dataobject
The dashboards in your project.
Show 1 propertyHide 1 property
- dashboardslist of objects
  The list of dashboard overviews.
  Show 9 propertiesHide 9 properties
  - idstring
    The unique id of the dashboard.
  - namestring
    The dashboard's name.
  - descriptionstring
    An optional description of the dashboard.
  - privateboolean
    Whether the dashboard is private to its creator.
  - projectIdstring
    The id of the project that owns the dashboard.
  - userIdstring
    The id of the dashboard creator, when available.
  - widgetCountinteger
    The number of widgets on the dashboard.
  - createdAtstring
    When the dashboard was created.
  - updatedAtstring
    When the dashboard was last updated.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI