Create a dashboard

A dashboard holds up to twenty widgets, each pointing at a saved report and carrying its own layout.

POST/api/v1/dashboards

Authorization

AuthorizationOAuth2 access token · headerrequired

Authorization-code grant with PKCE. Clients are public and hold no secret. Discovery is published at /.well-known/oauth-authorization-server/api/auth.

Scopes:api.access

Header parameters

Idempotency-Keystringrequired

Replays the first answer for a repeated request

min length 8 · max length 128

Request body

requiredapplication/json

namestringrequired

min length 1 · max length 120

widgetsobject[]required

max items 20

Show properties

Array of object

layoutobjectrequired

Show properties

heightintegerrequired

min 1 · max 12

widthintegerrequired

min 1 · max 12

xintegerrequired

min 0 · max 11

yintegerrequired

min 0 · max 100

reportIdstringrequired

min length 1 · max length 255

visualizationstringrequired

Allowed:numbertablebar

Responses

201

The dashboard was created

idstringrequired

min length 1 · max length 255

400

The request body, query or parameters were refused

codestringrequired

Allowed:invalid_inputnot_foundconflictforbidden

detailany

errorstringrequired

reasonstring

401

The access token is missing, invalid or revoked

errorstringrequired

403

The tenant's module is off, or the token's scope or the member's role does not permit the action

codestringrequired

Allowed:invalid_inputnot_foundconflictforbidden

detailany

errorstringrequired

reasonstring

404

No such record, or none the caller may read

codestringrequired

Allowed:invalid_inputnot_foundconflictforbidden

detailany

errorstringrequired

reasonstring

409

The operation conflicts with the current state

codestringrequired

Allowed:invalid_inputnot_foundconflictforbidden

detailany

errorstringrequired

reasonstring

413

The request exceeds the route's body limit

errorstringrequired

500

An unexpected failure

errorstringrequired

Request

curl -X POST '/api/v1/api/v1/dashboards' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Idempotency-Key: stringst' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "widgets": [
    {
      "layout": {
        "height": 1,
        "width": 1,
        "x": 0,
        "y": 0
      },
      "reportId": "string",
      "visualization": "number"
    }
  ]
}'

const response = await fetch("/api/v1/api/v1/dashboards", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Idempotency-Key": "stringst",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"widgets\": [\n    {\n      \"layout\": {\n        \"height\": 1,\n        \"width\": 1,\n        \"x\": 0,\n        \"y\": 0\n      },\n      \"reportId\": \"string\",\n      \"visualization\": \"number\"\n    }\n  ]\n}"
});

import requests

response = requests.post(
    "/api/v1/api/v1/dashboards",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Idempotency-Key": "stringst",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"widgets\": [\n    {\n      \"layout\": {\n        \"height\": 1,\n        \"width\": 1,\n        \"x\": 0,\n        \"y\": 0\n      },\n      \"reportId\": \"string\",\n      \"visualization\": \"number\"\n    }\n  ]\n}",
)

Response

{
  "id": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "error": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}