Dashboards API - GET a dashboard
Gets parameters of the specified dashboard.
The request produces an application/json
payload.
This request is an Early Adopter release and may be changed in non-compatible way.
GET |
|
Authentication
To execute this request, you need the Read configuration (ReadConfig
) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
id | string |
The ID of the required dashboard. |
path | required |
Response
Refer to Tile JSON models to find JSON models for each tile type.
Response codes
Code | Description |
---|---|
200 | Success. The response body contains parameters of the dashboard. |
Response body
The Dashboard object
Configuration of a dashboard.
Element | Type | Description |
---|---|---|
metadata | ConfigurationMetadata | |
id | string | The ID of the dashboard. |
dashboardMetadata | DashboardMetadata | |
tiles | Tile[] | The list of tiles on the dashboard. |
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 |
---|---|---|
name | string | The name of the tile. |
tileType | string | Defines the actual set of fields depending on the value. See one of the following objects:
|
configured | boolean | The tile is configured and ready to use ( |
bounds | TileBounds | |
tileFilter | TileFilter |
The TileFilter object
A filter applied to a tile.
It overrides dashboard's filter.
Element | Type | Description |
---|---|---|
timeframe | string | The default timeframe of the tile. |
managementZone | EntityShortRepresentation |
The TileBounds object
The position and size of a tile.
Element | Type | Description |
---|---|---|
top | integer | The vertical distance from the top left corner of the dashboard to the top left corner of the tile, in pixels. |
left | integer | The horizontal distance from the top left corner of the dashboard to the top left corner of the tile, in pixels. |
width | integer | The width of the tile, in pixels. |
height | integer | The height of the tile, in pixels. |
The DashboardMetadata object
Parameters of a dashboard.
Element | Type | Description |
---|---|---|
name | string | The name of the dashboard. |
shared | boolean | The dashboard is shared ( |
owner | string | The owner of the dashboard. |
sharingDetails | SharingInfo | |
dashboardFilter | DashboardFilter | |
tags | string[] | A set of tags assigned to the dashboard. |
preset | boolean | The dashboard is a preset ( |
validFilterKeys | string[] | A set of all possible global dashboard filters that can be applied to dashboard |
The DashboardFilter object
Filters, applied to a dashboard.
Element | Type | Description |
---|---|---|
timeframe | string | The default timeframe of the dashboard. |
managementZone | EntityShortRepresentation |
The EntityShortRepresentation object
The short representation of a Dynatrace entity.
Element | Type | Description |
---|---|---|
id | string | The ID of the Dynatrace entity. |
name | string | The name of the Dynatrace entity. |
description | string | A short description of the Dynatrace entity. |
The SharingInfo object
Sharing configuration of a dashboard.
Element | Type | Description |
---|---|---|
linkShared | boolean | If |
published | boolean | If |
The ConfigurationMetadata object
Metadata useful for debugging
Element | Type | Description |
---|---|---|
configurationVersions | integer[] | A Sorted list of the version numbers of the configuration. |
currentConfigurationVersions | string[] | A Sorted list of string version numbers of the configuration. |
clusterVersion | string | Dynatrace server version. |
{
"metadata": {
"configurationVersions": [
4,
2
],
"clusterVersion": "Mock version"
},
"dashboardMetadata": {
"name": "Example Dashboard",
"owner": "Example Owner",
"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
}
]
}
Example
In this example, the request lists the parameters of the Sample dashboard, which has the ID of 2768e6ca-e199-4433-9e0d-2922aec2099b.
The API token is passed in the Authorization header.
The dashboard looks like this in the UI:
Curl
curl -X GET \
https://mySampleEnv.live.dynatrace.com/api/config/v1/dashboards/2768e6ca-e199-4433-9e0d-2922aec2099b \
-H 'Authorization: Api-token abcdefjhij1234567890'
Request URL
https://mySampleEnv.live.dynatrace.com/api/config/v1/dashboards/2768e6ca-e199-4433-9e0d-2922aec2099b
Response body
{
"metadata": {
"clusterVersion": "1.166.0.20190311-110828",
"configurationVersions": [
2
]
},
"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"
]
}
]
}
Response code
200