Docs/API reference / Dashboards

Create dashboards

Requires `developer_api.dashboards.create` on the project-scoped Developer API connection. Use the API origin supplied for your deployment. Unknown query parameters and unexpected request bodies are rejected.

POST/dev-api/v1/p/{project_id}/dashboardsAll endpoints ↗

The request panel saves credentials and API settings in this browser. Privacy details

Authorization

developerApiKey

AuthorizationBearer <token>

Project-scoped Developer API connection key. Grant only the required operation permissions.

In: header

Path Parameters

project_id*string

Match.*\S.*

Length1 <= length <= 128

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

bash

curl -X POST "https://example.com/dev-api/v1/p/string/dashboards" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string"
  }'

json

{
  "request_id": "string",
  "data": {
    "lifecycle_state": "active",
    "archived_at": "2019-08-24T14:15:22Z",
    "archived_by": {
      "type": "user",
      "id": "string"
    },
    "id": "string",
    "name": "string",
    "revision": 1,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Authorization

Path Parameters

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

404application/json

405application/json

409application/json

413application/json

415application/json

429application/json

500application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`