Dashboard
Manage Builder UI Dashboards.
Create
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
| Field | Type | Required | Default |
|---|---|---|---|
| layout | string | ||
| name | string | yes | |
| range | object | ||
| responsive | boolean | ||
| widgets | array | [] |
Widgets
An array of Widgets items.
| Field | Type |
|---|---|
| cloudId | string |
| dashboard | string |
| dimensions | object |
| field | string |
| height | string |
| id | string |
| left | string |
| limit | number |
| metric | string |
| model | string |
| name | string |
| namespace | string |
| presentation | string |
| region | string |
| statistic | string |
| top | string |
| type | string |
| units | string |
| width | string |
| z | string |
Response
| Field | Type |
|---|---|
| accountId | string |
| id | string |
| layout | string |
| name | string |
| range | object |
| responsive | boolean |
| widgets | array |
Widgets
An array of Widgets items.
| Field | Type |
|---|---|
| cloudId | string |
| dashboard | string |
| dimensions | object |
| field | string |
| height | string |
| id | string |
| left | string |
| limit | number |
| metric | string |
| model | string |
| name | string |
| namespace | string |
| presentation | string |
| region | string |
| statistic | string |
| top | string |
| type | string |
| units | string |
| width | string |
| z | string |
Find
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
A object.
Query String Options
| Field | Type |
|---|---|
| hidden | boolean |
| filter | string |
| limit | number |
| next | object |
| prev | object |
| index | string |
| where | string |
| log | boolean |
Response
Paged response.
| Field | Type | Notes |
|---|---|---|
| data | array | A list of cloud records. |
| next | string | Paged cursor to use for the next page of items. |
| prev | string | Pages cursor to use for the previous page of items. |
Dashboard
An array of Dashboard items.
| Field | Type |
|---|---|
| accountId | string |
| id | string |
| layout | string |
| name | string |
| range | object |
| responsive | boolean |
| widgets | array |
Widgets
An array of Widgets items.
| Field | Type |
|---|---|
| cloudId | string |
| dashboard | string |
| dimensions | object |
| field | string |
| height | string |
| id | string |
| left | string |
| limit | number |
| metric | string |
| model | string |
| name | string |
| namespace | string |
| presentation | string |
| region | string |
| statistic | string |
| top | string |
| type | string |
| units | string |
| width | string |
| z | string |
Get
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
| Field | Type |
|---|---|
| id | string |
Response
| Field | Type |
|---|---|
| accountId | string |
| id | string |
| layout | string |
| name | string |
| range | object |
| responsive | boolean |
| widgets | array |
Widgets
An array of Widgets items.
| Field | Type |
|---|---|
| cloudId | string |
| dashboard | string |
| dimensions | object |
| field | string |
| height | string |
| id | string |
| left | string |
| limit | number |
| metric | string |
| model | string |
| name | string |
| namespace | string |
| presentation | string |
| region | string |
| statistic | string |
| top | string |
| type | string |
| units | string |
| width | string |
| z | string |
Init
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
A object.
Response
| Field | Type |
|---|---|
| accountId | string |
| id | string |
| layout | string |
| name | string |
| range | object |
| responsive | boolean |
| widgets | array |
Widgets
An array of Widgets items.
| Field | Type |
|---|---|
| cloudId | string |
| dashboard | string |
| dimensions | object |
| field | string |
| height | string |
| id | string |
| left | string |
| limit | number |
| metric | string |
| model | string |
| name | string |
| namespace | string |
| presentation | string |
| region | string |
| statistic | string |
| top | string |
| type | string |
| units | string |
| width | string |
| z | string |
Remove
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
| Field | Type |
|---|---|
| id | string |
Update
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
| Field | Type | Required |
|---|---|---|
| id | string | |
| layout | string | |
| name | string | yes |
| range | object | |
| responsive | boolean | |
| widgets | array |
Response
| Field | Type |
|---|---|
| accountId | string |
| id | string |
| layout | string |
| name | string |
| range | object |
| responsive | boolean |
| widgets | array |
Widgets
An array of Widgets items.
| Field | Type |
|---|---|
| cloudId | string |
| dashboard | string |
| dimensions | object |
| field | string |
| height | string |
| id | string |
| left | string |
| limit | number |
| metric | string |
| model | string |
| name | string |
| namespace | string |
| presentation | string |
| region | string |
| statistic | string |
| top | string |
| type | string |
| units | string |
| width | string |
| z | string |