Delete dashboard

Prev Next
Delete
/v1alpha/dashboards/{dashboard_id}

Deletes a dashboard and its widgets, and shortly after, its scheduled reports. Organization dashboards cannot be deleted from a workspace. The API key must be able to see the dashboard, as described in List dashboards.

Security
HTTP
Type bearer
Path parameters
dashboard_id
stringRequired

The ID of the dashboard to delete. With an API key whose role includes the Bypass cases dashboard restriction permission, a dashboard that does not exist or was already deleted returns NOT_FOUND. Without it, a dashboard that does not exist and one the key cannot see both return PERMISSION_DENIED with the same message.

Responses
200

A successful response.

object
id
string

The ID of the deleted dashboard.

Example0f8fad5b-d9cb-469f-a165-70867728950e
401

Invalid bearer token. If you receive this message more than once try creating a new Client ID/Client Secret or generating a new bearer token.

object
403

You don't have permission to access this resource.

object