Skip to content

Get custom dashboards​

GET
/api/v2/custom-dashboard

Get custom dashboards

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Query Parameters

_limit

Set the max number of custom dashboards to return.

Type
integer
Format
"int64"
_offset

Set the number of objects to ignore before starting.

Type
integer
Format
"int64"
permissions

Whether we'd like the custom dashboard permissions for user making request.

Type
boolean

Responses​

A list of custom dashboards user has access to.

Playground​

Authorization
Variables
Key
Value

Samples​


Create a custom dashboard​

POST
/api/v2/custom-dashboard

Create a custom dashboard

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
"string"

Responses​

Create dashboard succeeded

Playground​

Authorization
Body

Samples​


Deletes an existing custom dashboard​

DELETE
/api/v2/custom-dashboard/{id}

Deletes an existing custom dashboard

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

The id of the custom dashboard

Type
string
Required

Responses​

Deleted Custom Dashboard

Playground​

Authorization
Variables
Key
Value

Samples​


Updates an existing custom dashboard​

PATCH
/api/v2/custom-dashboard/{id}

Updates an existing custom dashboard

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

The id of the custom dashboard

Type
string
Required

Request Body​

application/json
JSON
"string"

Responses​

Update dashboard succeeded

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Powered by VitePress OpenAPI