Skip to main content
POST
Create a dashboard

Request Structure

Key Fields

Adding widgets

Use PUT /api/dashboards/{id}/widgets (setDashboardWidgetPlacements) to attach widgets to the dashboard. That endpoint replaces all placements atomically.

Authorizations

Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Body

application/json
data
object
required

Response

Dashboard created successfully. Response contains the new dashboard's id.

id
integer

Identifier of the created dashboard