List Dashboards

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

Lists the dashboards in your Confident AI project one page at a time, newest first. Each dashboard is returned with its widgets counted; retrieve one by id for their configuration, or query it for their data.

GET/v2/dashboards

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

200

{
  "success": true,
  "data": {
    "dashboards": [
      {
        "id": "<DASHBOARD-ID>",
        "name": "Production overview",
        "description": "Traffic and latency across production.",
        "private": false,
        "user": {
          "id": "<USER-ID>",
          "email": "jane@acme.com",
          "name": "Jane Doe",
          "image": null
        },
        "createdAt": "2025-01-15T10:30:00.000Z",
        "updatedAt": "2025-01-15T10:30:00.000Z",
        "widgetCount": 4
      }
    ],
    "totalDashboards": 7,
    "page": 1,
    "pageSize": 25
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Query parameters

pageintegerdefault: 1
The page to return. Defaults to 1.
pageSizeintegerdefault: 25
The number of results per page, at most 100. Defaults to 25.

Response

List Dashboards succeeded.

successboolean
Indicates if the request was successful.
dataobject
One page of dashboards, with the total across all pages.
Show 4 propertiesHide 4 properties
- dashboardslist of objects
  The dashboards for the current page, newest first.
  Show 8 propertiesHide 8 properties
  - idstring
    The id of the dashboard, generated by Confident AI.
  - namestring
    The name of the dashboard.
  - descriptionstring | null
    What the dashboard covers, or null when it has no description.
  - privateboolean
    Whether the dashboard is visible only to its creator.
  - userobject | null
    A Confident AI user, as referenced by the records they created.
    Show 4 propertiesHide 4 properties
    idstring
    This is the id of the user.
    emailstring
    This is the email address of the user.
    namestring | null
    This is the display name of the user, or null when they have not set one.
    imagestring | null
    This is the URL of the user's avatar, or null when they have none.
  - createdAtstring
    When the dashboard was created.
  - updatedAtstring
    When the dashboard was last changed.
  - widgetCountinteger
    How many widgets the dashboard holds.
- totalDashboardsinteger
  The total number of dashboards in this project.
- pageinteger
  The page this response covers.
- pageSizeinteger
  The number of dashboards per page.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI