Dashboards API - PUT a dashboard
Updates the specified dashboard.
The request consumes and produces an application/json
payload.
This request is an early adopter release and may be changed in non compatible way.
PUT |
|
Parameters
Refer to Tile JSON models to find JSON models for each tile type.
Parameter | Type | Description | In | Required |
---|---|---|---|---|
id | string |
The ID of the dashboard to be updated. The ID in the request body provides must match this ID. |
path | required |
body | Dashboard |
The JSON body of the request. Contains updated parameters of the dashboard. |
body | optional |
The Dashboard object
Configuration of a dashboard.
Element | Type | Description | Required |
---|---|---|---|
metadata | ConfigurationMetadata |
Metadata useful for debugging. |
optional |
id | string |
The ID of the dashboard. |
optional |
dashboardMetadata | DashboardMetadata |
Parameters of the dashboard. |
required |
tiles | Tile[] |
The list of tiles on the dashboard. |
required |
The Tile object
Configuration of a tile.
The actual set of fields depends on the type of the tile. See the description of the tileType field.
Element | Type | Description | Required |
---|---|---|---|
name | string |
The name of the tile. |
required |
tileType | string |
Defines the actual set of fields depending on the value: CUSTOM_CHARTING -> CustomChartingTile DTAQL -> UserSessionQueryTile MARKDOWN -> MarkdownTile HOSTS -> FilterableEntityTile APPLICATIONS -> FilterableEntityTile SERVICES -> FilterableEntityTile DATABASES_OVERVIEW -> FilterableEntityTile SYNTHETIC_TESTS -> FilterableEntityTile APPLICATION_WORLDMAP -> AssignedEntitiesWithMetricTile RESOURCES -> AssignedEntitiesWithMetricTile THIRD_PARTY_MOST_ACTIVE -> AssignedEntitiesWithMetricTile SYNTHETIC_SINGLE_WEBCHECK -> AssignedEntitiesWithMetricTile UEM_CONVERSIONS_PER_GOAL -> AssignedEntitiesWithMetricTile HOST -> AssignedEntitiesWithMetricTile PROCESS_GROUPS_ONE -> AssignedEntitiesWithMetricTile SYNTHETIC_SINGLE_WEBCHECK -> SyntheticSingleWebcheckTile APPLICATION -> AssignedEntitiesTile VIRTUALIZATION -> AssignedEntitiesTile AWS -> AssignedEntitiesTile SERVICE_VERSATILE -> AssignedEntitiesTile SESSION_METRICS -> AssignedEntitiesTile USERS -> AssignedEntitiesTile UEM_KEY_USER_ACTIONS -> AssignedEntitiesTile BOUNCE_RATE -> AssignedEntitiesTile UEM_CONVERSIONS_OVERALL -> AssignedEntitiesTile UEM_JSERRORS_OVERALL -> AssignedEntitiesTile MOBILE_APPLICATION -> AssignedEntitiesTile SYNTHETIC_SINGLE_EXT_TEST -> AssignedEntitiesTile SYNTHETIC_HTTP_MONITOR -> AssignedEntitiesTile DATABASE -> AssignedEntitiesTile CUSTOM_APPLICATION -> AssignedEntitiesTile APPLICATION_METHOD -> AssignedEntitiesTile LOG_ANALYTICS -> AssignedEntitiesTile OPENSTACK -> AssignedEntitiesTile OPENSTACK_PROJECT -> AssignedEntitiesTile OPENSTACK_AV_ZONE -> AssignedEntitiesTile The tileType element can hold these values. |
required |
configured | boolean |
The tile is configured and ready to use ( |
optional |
bounds | TileBounds |
The position and size of the tile. |
required |
tileFilter | TileFilter |
A filter, applied to the tile. |
optional |
The TileFilter object
A filter applied to a tile.
It overrides dashboard's filter.
Element | Type | Description | Required |
---|---|---|---|
timeframe | string |
The default timeframe of the tile. |
optional |
managementZone | EntityShortRepresentation |
The management zone to which the tile belongs. |
optional |
The TileBounds object
The position and size of a tile.
Element | Type | Description | Required |
---|---|---|---|
top | integer |
The vertical distance from the top left corner of the dashboard to the top left corner of the tile, in pixels. |
optional |
left | integer |
The horizontal distance from the top left corner of the dashboard to the top left corner of the tile, in pixels. |
optional |
width | integer |
The width of the tile, in pixels. |
optional |
height | integer |
The height of the tile, in pixels. |
optional |
The DashboardMetadata object
Parameters of a dashboard.
Element | Type | Description | Required |
---|---|---|---|
name | string |
The name of the dashboard. |
required |
shared | boolean |
The dashboard is shared ( |
optional |
owner | string |
The owner of the dashboard. |
optional |
sharingDetails | SharingInfo |
How the dashboard is shared. If shared is set to |
optional |
dashboardFilter | DashboardFilter |
Filters, applied to the dashboard. |
optional |
The DashboardFilter object
Filters, applied to a dashboard.
Element | Type | Description | Required |
---|---|---|---|
timeframe | string |
The default timeframe of the dashboard. |
optional |
managementZone | EntityShortRepresentation |
The management zone to which the dashboard belongs. |
optional |
The EntityShortRepresentation object
The short representation of a DESK entity.
Element | Type | Description | Required |
---|---|---|---|
id | string |
The ID of the DESK entity. |
required |
name | string |
The name of the DESK entity. |
optional |
description | string |
A short description of the DESK entity. |
optional |
The SharingInfo object
Sharing configuration of a dashboard.
Element | Type | Description | Required |
---|---|---|---|
linkShared | boolean |
If |
optional |
published | boolean |
If |
optional |
The ConfigurationMetadata object
Metadata useful for debugging
Element | Type | Description | Required |
---|---|---|---|
configurationVersions | integer[] |
A Sorted list of the version numbers of the configuration. |
optional |
clusterVersion | string |
DESK server version. |
optional |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.
{
"metadata": {
"configurationVersions": [
4,
2
],
"clusterVersion": {
"major": 0,
"minor": 0,
"revision": 0,
"sourceRevision": "",
"timestamp": ""
}
},
"dashboardMetadata": {
"name": "Example Dashboard",
"shared": true,
"sharingDetails": {
"linkShared": true,
"published": false
},
"dashboardFilter": {
"timeframe": "l_72_HOURS",
"managementZone": {
"id": "3438779970106539862",
"name": "Example Management Zone"
}
}
},
"tiles": [
{
"name": "Hosts",
"tileType": "HEADER",
"configured": true,
"bounds": {
"top": 0,
"left": 0,
"width": 304,
"height": 38
},
"tileFilter": {}
},
{
"name": "Applications",
"tileType": "HEADER",
"configured": true,
"bounds": {
"top": 0,
"left": 304,
"width": 304,
"height": 38
},
"tileFilter": {}
},
{
"name": "Host health",
"tileType": "HOSTS",
"configured": true,
"bounds": {
"top": 38,
"left": 0,
"width": 304,
"height": 304
},
"tileFilter": {
"managementZone": {
"id": "3438779970106539862",
"name": "Example Management Zone"
}
},
"chartVisible": true
},
{
"name": "Application health",
"tileType": "APPLICATIONS",
"configured": true,
"bounds": {
"top": 38,
"left": 304,
"width": 304,
"height": 304
},
"tileFilter": {
"managementZone": {
"id": "3438779970106539862",
"name": "Example Management Zone"
}
},
"chartVisible": true
}
]
}
Possible values
Possible values for the tileType element in the Tile object:
- CUSTOM_CHARTING
- DTAQL
- MARKDOWN
- HOSTS
- APPLICATIONS
- SERVICES
- DATABASES_OVERVIEW
- SYNTHETIC_TESTS
- APPLICATION_WORLDMAP
- RESOURCES
- THIRD_PARTY_MOST_ACTIVE
- SYNTHETIC_SINGLE_WEBCHECK
- UEM_CONVERSIONS_PER_GOAL
- HOST
- PROCESS_GROUPS_ONE
- SYNTHETIC_SINGLE_WEBCHECK
- APPLICATION
- VIRTUALIZATION
- AWS
- SERVICE_VERSATILE
- SESSION_METRICS
- USERS
- UEM_KEY_USER_ACTIONS
- BOUNCE_RATE
- UEM_CONVERSIONS_OVERALL
- UEM_JSERRORS_OVERALL
- MOBILE_APPLICATION
- SYNTHETIC_SINGLE_EXT_TEST
- SYNTHETIC_HTTP_MONITOR
- DATABASE
- CUSTOM_APPLICATION
- APPLICATION_METHOD
- LOG_ANALYTICS
- OPENSTACK
- OPENSTACK_PROJECT
- OPENSTACK_AV_ZONE
Response format
The EntityShortRepresentation object
The short representation of a DESK entity.
Element | Type | Description |
---|---|---|
id | string | The ID of the DESK entity. |
name | string | The name of the DESK entity. |
description | string | A short description of the DESK entity. |
{}
Response codes
Code | Description |
---|---|
201 | Success. The new dashboard has been created. Response doesn't have a body. |
204 | Success. The dashboard has been updated. Response doesn't have a body |
400 | Failed. The input is invalid. |
Validate payload
We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.
The request consumes an application/json
payload.
This request is an early adopter release and may be changed in non compatible way.
POST |
|
Response code
This request is an early adopter release and may be changed in non compatible way.
POST |
|
Example
In this example, the request adds the Service health tile to the Sample dashboard in the GET request example.
The tile shows the health of all services belonging to the Easytravel management zone. It is located next to the existing Host health tile and has the same size (304x304 pixels).
The API token is passed in the Authorization header.
Since the request body is lengthy, it is truncated in this example Curl section. See the full body in the Request body section. You can download or copy the example request body to try it out on your own. Be sure to change the ID and name of the Easytravel management zone to a management zone that exists in your environment or set this field to null
.
Curl
curl -X PUT \
https://mySampleEnv.live.dexp.ae/api/config/v1/dashboards/2768e6ca-e199-4433-9e0d-2922aec2099b \
-H 'Authorization: Api-token abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
-d '{<truncated - see the Request body section >}'
Request URL
https://mySampleEnv.live.dexp.ae/api/config/v1/dashboards/2768e6ca-e199-4433-9e0d-2922aec2099b
Request body
api-examples/config/dashboards/put-dashboard.json
{
"id": "2768e6ca-e199-4433-9e0d-2922aec2099b",
"dashboardMetadata": {
"name": "Sample dashboard",
"shared": true,
"owner": "john.smith",
"sharingDetails": {
"linkShared": true,
"published": true
},
"dashboardFilter": {
"timeframe": "l_2_HOURS",
"managementZone": null
}
},
"tiles": [
{
"name": "Host health",
"tileType": "HOSTS",
"configured": true,
"bounds": {
"top": 0,
"left": 304,
"width": 304,
"height": 304
},
"tileFilter": {
"managementZone": {
"id": "9130632296508575249",
"name": "Easytravel"
}
},
"filterConfig": null,
"chartVisible": true
},
{
"name": "User behavior",
"tileType": "SESSION_METRICS",
"configured": true,
"bounds": {
"top": 0,
"left": 0,
"width": 304,
"height": 304
},
"tileFilter": {
"managementZone": null
},
"assignedEntities": [
"APPLICATION-8E41C8C247910758"
]
},
{
"name": "Service health",
"tileType": "SERVICES",
"configured": true,
"bounds": {
"top": 0,
"left": 608,
"width": 304,
"height": 304
},
"tileFilter": {
"managementZone": {
"id": "9130632296508575249",
"name": "Easytravel"
}
},
"filterConfig": null,
"chartVisible": true
}
]
}
Response code
204