Project data modelsDashboards

Create Dashboard

Creates a dashboard, optionally with starter widget configurations, and returns the id of the created dashboard. Use the dashboard detail endpoint for its full configuration, or a query endpoint for computed widget data.

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Request

The dashboard configuration to create.
namestringRequired
The dashboard's name.
descriptionstring or nullOptional
An optional description of the dashboard.
privatebooleanOptional
Whether the dashboard is private. Defaults to false.
widgetslist of objectsOptional
Optional starter widgets to create alongside the dashboard.

Response

The id of the created dashboard.
successboolean
Indicates if the request was successful.
dataobject
The id of the affected dashboard or widget.
deprecatedboolean
Indicates if this endpoint is deprecated.