Dashboard

Save my dashboard

POST/api/dashboard

Creates or updates the current user's personal dashboard with the supplied name, description, and configuration.

Headers

Name	Type	Description
Authorizationrequired	string	Authentication credentials, e.g. `Bearer <token>`.

Request body

Name	Type	Description
description	string	Description of the dashboard.
name	string	Display name of the dashboard.
parameters	object	Dashboard configuration, including components, layout, and saved reports.

Example request

{
  "description": "string",
  "name": "string",
  "parameters": {}
}

Responses

200The operation completed successfully.

Name	Type	Description
createdAtrequired	string	Date and time the record was created.
descriptionrequired	string	Description of the dashboard.
idrequired	string	Dashboard board ID, equal to the owning user ID.
namerequired	string	Display name of the dashboard.
parametersrequired	anyOf	Dashboard configuration, including components, layout, and saved reports.

teamIdrequired	string	ID of the associated team, if any.
typerequired	string	Board type used for the dashboard.
updatedAtrequired	string	Date and time the record was last updated.
userIdrequired	string	ID of the user who owns the dashboard.

200 example

{
  "createdAt": "2024-01-15T09:30:00Z",
  "description": "string",
  "id": "string",
  "name": "string",
  "parameters": "string",
  "teamId": "string",
  "type": "string",
  "updatedAt": "2024-01-15T09:30:00Z",
  "userId": "string"
}

400Bad request.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

400 example

{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

Code samples

cURL

curl -X POST 'https://api.example.com/api/dashboard' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "description": "string",
  "name": "string",
  "parameters": {}
}'

PreviousGet my dashboard NextList events with custom properties