Dashboards API - Tile JSON models
JSON models of dashboard tiles vary greatly, depending on the type of a tile. Here you can find JSON models for each tile type.
AssignedEntitiesTile
This type applies to the following tiles:
- AWS (
AWS
) - Bounce rate (
BOUNCE_RATE
) - Custom application (
CUSTOM_APPLICATION
) - Database performance (
DATABASE
) - External monitor (
SYNTHETIC_SINGLE_EXT_TEST
) - HTTP monitor (
SYNTHETIC_HTTP_MONITOR
) - JavaScript errors (
UEM_JSERRORS_OVERALL
) - Key user actions (
UEM_KEY_USER_ACTIONS
)
- Mobile app (
MOBILE_APPLICATION
) - Service or request (
SERVICE_VERSATILE
) - Top conversion goals (
UEM_CONVERSIONS_OVERALL
) - User behavior (
SESSION_METRICS
) - User breakdown (
USERS
) - VMware (
VIRTUALIZATION
) - Web application (
APPLICATION
)
The AssignedEntitiesTile 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. See one of the following objects:
|
required |
configured | boolean |
The tile is configured and ready to use ( |
optional |
bounds | TileBounds | required | |
tileFilter | TileFilter | optional | |
assignedEntities | string[] |
The list of Dynatrace entities, assigned to the tile. |
required |
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 | optional |
The EntityShortRepresentation object
The short representation of a Dynatrace entity.
Element | Type | Description | Required |
---|---|---|---|
id | string |
The ID of the Dynatrace entity. |
required |
name | string |
The name of the Dynatrace entity. |
optional |
description | string |
A short description of the Dynatrace entity. |
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 |
{
"name": "AWS",
"tileType": "AWS",
"configured": true,
"bounds": {
"top": 192,
"left": 62,
"width": 304,
"height": 152
},
"tileFilter": {
"timeframe": "Today"
},
"assignedEntities": [
"556925984968688946"
]
}
FilterableEntityTile
This type applies to the following tiles:
- Application health (
APPLICATIONS
) - Data center services health (
DCRUM_SERVICES
) - Database health (
DATABASES_OVERVIEW
) - Docker (
DOCKER
) - Header (
HEADER
) - Host health (
HOSTS
) - Live user activity (
UEM_ACTIVE_SESSIONS
)
- Network metric (
NETWORK
) - Network status (
NETWORK_MEDIUM
) - Problems (
OPEN_PROBLEMS
) - Service health (
SERVICES
) - Smartscape (
PURE_MODEL
) - Synthetic monitor health (
SYNTHETIC_TESTS
) - Top web applications (
APPLICATIONS_MOST_ACTIVE
)
The FilterableEntityTile 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. See one of the following objects:
|
required |
configured | boolean |
The tile is configured and ready to use ( |
optional |
bounds | TileBounds | required | |
tileFilter | TileFilter | optional | |
filterConfig | CustomFilterConfig | optional | |
chartVisible | boolean | optional |
The CustomFilterConfig object
Configuration of the custom filter of a tile.
Element | Type | Description | Required |
---|---|---|---|
type | string |
The type of the filter. It shows to which entity the filter belongs. Custom charts have the
|
required |
customName | string |
The name of the tile, set by user |
required |
defaultName | string |
The default name of the tile |
required |
chartConfig | CustomFilterChartConfig | required | |
filtersPerEntityType | object |
A list of filters, applied to specific entity types. |
required |
The CustomFilterChartConfig object
Configuration of a custom chart.
Element | Type | Description | Required |
---|---|---|---|
legendShown | boolean |
Defines if a legend should be shown. |
optional |
type | string |
The type of the chart.
|
required |
series | CustomFilterChartSeriesConfig[] |
A list of charted metrics. |
required |
resultMetadata | object |
Additional information about charted metric. |
required |
axisLimits | object |
The optional custom y-axis limits. |
optional |
leftAxisCustomUnit | string |
The custom unit for the left Y-axis.
|
optional |
rightAxisCustomUnit | string |
The custom unit for the right Y-axis.
|
optional |
The CustomChartingItemMetadataConfig object
Additional metadata for charted metric.
Element | Type | Description | Required |
---|---|---|---|
lastModified | integer |
The timestamp of the last metadata modification, in UTC milliseconds. |
optional |
customColor | string |
The color of the metric in the chart, hex format. |
required |
The CustomFilterChartSeriesConfig object
Configuration of a charted metric.
Element | Type | Description | Required |
---|---|---|---|
metric | string |
The name of the charted metric. |
required |
aggregation | string |
The charted aggregation of the metric.
|
required |
percentile | integer |
The charted percentile. Only applicable if the aggregation is set to |
optional |
type | string |
The visualization of the timeseries chart.
|
required |
entityType | string |
The type of the Dynatrace entity that delivered the charted metric. |
required |
dimensions | CustomFilterChartSeriesDimensionConfig[] |
Configuration of the charted metric splitting. |
required |
sortAscending | boolean |
Sort ascending ( |
optional |
sortColumn | boolean | optional | |
aggregationRate | string |
|
optional |
The CustomFilterChartSeriesDimensionConfig object
Configuration of the charted metric splitting.
Element | Type | Description | Required |
---|---|---|---|
id | string |
The ID of the dimension by which the metric is split. |
required |
name | string |
The name of the dimension by which the metric is split. |
optional |
values | string[] |
The splitting value. |
required |
entityDimension | boolean | 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 | optional |
The EntityShortRepresentation object
The short representation of a Dynatrace entity.
Element | Type | Description | Required |
---|---|---|---|
id | string |
The ID of the Dynatrace entity. |
required |
name | string |
The name of the Dynatrace entity. |
optional |
description | string |
A short description of the Dynatrace entity. |
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 |
{
"name": "Host health",
"tileType": "HOSTS",
"configured": true,
"bounds": {
"top": 47,
"left": 415,
"width": 304,
"height": 304
},
"tileFilter": {
"timeframe": "-3h to now",
"managementZone": {
"id": "9130632296508575249",
"name": "Easytravel"
}
},
"filterConfig": null,
"chartVisible": true
}
AssignedEntitiesWithMetricTile
This type applies to the following tiles:
- World map (
APPLICATION_WORLDMAP
)
- Resources (
RESOURCES
) - Browser monitor (
SYNTHETIC_SINGLE_WEBCHECK
) - Most used 3rd parties (
THIRD_PARTY_MOST_ACTIVE
) - Conversion goal (
UEM_CONVERSIONS_PER_GOAL
)
The AssignedEntitiesWithMetricTile 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. See one of the following objects:
|
required |
configured | boolean |
The tile is configured and ready to use ( |
optional |
bounds | TileBounds | required | |
tileFilter | TileFilter | optional | |
assignedEntities | string[] |
The list of Dynatrace entities, assigned to the tile. |
required |
metric | string |
The metric assigned 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 | optional |
The EntityShortRepresentation object
The short representation of a Dynatrace entity.
Element | Type | Description | Required |
---|---|---|---|
id | string |
The ID of the Dynatrace entity. |
required |
name | string |
The name of the Dynatrace entity. |
optional |
description | string |
A short description of the Dynatrace entity. |
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 |
{
"name": "World map",
"tileType": "APPLICATION_WORLDMAP",
"configured": true,
"bounds": {
"top": 118,
"left": 194,
"width": 304,
"height": 304
},
"tileFilter": {
"timeframe": "-12h to now",
"managementZone": null
},
"assignedEntities": [
"APPLICATION-C93B8002996906CD"
],
"metric": "SESSION_USERS"
}
CustomChartingTile
This type applies to the following tiles:
- Custom chart (
CUSTOM_CHARTING
)
The CustomChartingTile 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. See one of the following objects:
|
required |
configured | boolean |
The tile is configured and ready to use ( |
optional |
bounds | TileBounds | required | |
tileFilter | TileFilter | optional | |
filterConfig | CustomFilterConfig | optional |
The CustomFilterConfig object
Configuration of the custom filter of a tile.
Element | Type | Description | Required |
---|---|---|---|
type | string |
The type of the filter. It shows to which entity the filter belongs. Custom charts have the
|
required |
customName | string |
The name of the tile, set by user |
required |
defaultName | string |
The default name of the tile |
required |
chartConfig | CustomFilterChartConfig | required | |
filtersPerEntityType | object |
A list of filters, applied to specific entity types. |
required |
The CustomFilterChartConfig object
Configuration of a custom chart.
Element | Type | Description | Required |
---|---|---|---|
legendShown | boolean |
Defines if a legend should be shown. |
optional |
type | string |
The type of the chart.
|
required |
series | CustomFilterChartSeriesConfig[] |
A list of charted metrics. |
required |
resultMetadata | object |
Additional information about charted metric. |
required |
axisLimits | object |
The optional custom y-axis limits. |
optional |
leftAxisCustomUnit | string |
The custom unit for the left Y-axis.
|
optional |
rightAxisCustomUnit | string |
The custom unit for the right Y-axis.
|
optional |
The CustomChartingItemMetadataConfig object
Additional metadata for charted metric.
Element | Type | Description | Required |
---|---|---|---|
lastModified | integer |
The timestamp of the last metadata modification, in UTC milliseconds. |
optional |
customColor | string |
The color of the metric in the chart, hex format. |
required |
The CustomFilterChartSeriesConfig object
Configuration of a charted metric.
Element | Type | Description | Required |
---|---|---|---|
metric | string |
The name of the charted metric. |
required |
aggregation | string |
The charted aggregation of the metric.
|
required |
percentile | integer |
The charted percentile. Only applicable if the aggregation is set to |
optional |
type | string |
The visualization of the timeseries chart.
|
required |
entityType | string |
The type of the Dynatrace entity that delivered the charted metric. |
required |
dimensions | CustomFilterChartSeriesDimensionConfig[] |
Configuration of the charted metric splitting. |
required |
sortAscending | boolean |
Sort ascending ( |
optional |
sortColumn | boolean | optional | |
aggregationRate | string |
|
optional |
The CustomFilterChartSeriesDimensionConfig object
Configuration of the charted metric splitting.
Element | Type | Description | Required |
---|---|---|---|
id | string |
The ID of the dimension by which the metric is split. |
required |
name | string |
The name of the dimension by which the metric is split. |
optional |
values | string[] |
The splitting value. |
required |
entityDimension | boolean | 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 | optional |
The EntityShortRepresentation object
The short representation of a Dynatrace entity.
Element | Type | Description | Required |
---|---|---|---|
id | string |
The ID of the Dynatrace entity. |
required |
name | string |
The name of the Dynatrace entity. |
optional |
description | string |
A short description of the Dynatrace entity. |
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 |
{
"name": "Custom chart",
"tileType": "CUSTOM_CHARTING",
"configured": true,
"bounds": {
"top": 115,
"left": 205,
"width": 304,
"height": 304
},
"tileFilter": {
"timeframe": "-1d to -12h",
"managementZone": {
"id": "9130632296508575249",
"name": "Easytravel"
}
},
"filterConfig": {
"type": "MIXED",
"customName": "CPU idle",
"defaultName": "Custom chart",
"chartConfig": {
"type": "TIMESERIES",
"series": [
{
"metric": "builtin:host.cpu.idle",
"aggregation": "AVG",
"percentile": null,
"type": "LINE",
"entityType": "HOST",
"dimensions": [],
"sortAscending": false,
"sortColumn": false,
"aggregationRate": "TOTAL"
},
{
"metric": "builtin:host.cpu.load",
"aggregation": "MAX",
"percentile": null,
"type": "AREA",
"entityType": "HOST",
"dimensions": [],
"sortAscending": false,
"sortColumn": true,
"aggregationRate": "TOTAL"
}
],
"resultMetadata": {}
},
"filtersPerEntityType": {
"HOST": {
"AUTO_TAGS": [
"easyTravel"
]
}
}
}
}
MarkdownTile
This type applies to the following tiles:
- Markdown (
MARKDOWN
)
The MarkdownTile 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. See one of the following objects:
|
required |
configured | boolean |
The tile is configured and ready to use ( |
optional |
bounds | TileBounds | required | |
tileFilter | TileFilter | optional | |
markdown | string |
The markdown-formatted content of the tile. |
required |
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 | optional |
The EntityShortRepresentation object
The short representation of a Dynatrace entity.
Element | Type | Description | Required |
---|---|---|---|
id | string |
The ID of the Dynatrace entity. |
required |
name | string |
The name of the Dynatrace entity. |
optional |
description | string |
A short description of the Dynatrace entity. |
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 |
{
"name": "Markdown",
"tileType": "MARKDOWN",
"configured": true,
"bounds": {
"top": 252,
"left": 173,
"width": 304,
"height": 152
},
"tileFilter": {
"timeframe": null,
"managementZone": null
},
"markdown": "## This is a Markdown tile\n\nIt supports **rich text** and [links](https://dynatrace.com)"
}
SyntheticSingleWebcheckTile
This type applies to the following tiles:
- Browser monitor (
SYNTHETIC_SINGLE_WEBCHECK
)
The SyntheticSingleWebcheckTile 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. See one of the following objects:
|
required |
configured | boolean |
The tile is configured and ready to use ( |
optional |
bounds | TileBounds | required | |
tileFilter | TileFilter | optional | |
assignedEntities | string[] |
The list of Dynatrace entities, assigned to the tile. |
required |
excludeMaintenanceWindows | boolean |
Include ( |
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 | optional |
The EntityShortRepresentation object
The short representation of a Dynatrace entity.
Element | Type | Description | Required |
---|---|---|---|
id | string |
The ID of the Dynatrace entity. |
required |
name | string |
The name of the Dynatrace entity. |
optional |
description | string |
A short description of the Dynatrace entity. |
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 |
{
"name": "Browser monitor",
"tileType": "SYNTHETIC_SINGLE_WEBCHECK",
"configured": true,
"bounds": {
"top": 209,
"left": 214,
"width": 304,
"height": 304
},
"tileFilter": {
"timeframe": "-24h to now",
"managementZone": null
},
"assignedEntities": [
"SYNTHETIC_TEST-0000000000016ACF"
],
"excludeMaintenanceWindows": true
}
UserSessionQueryTile
This type applies to the following tiles:
- User session query (
DTAQL
)
The UserSessionQueryTile 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. See one of the following objects:
|
required |
configured | boolean |
The tile is configured and ready to use ( |
optional |
bounds | TileBounds | required | |
tileFilter | TileFilter | optional | |
customName | string |
The name of the tile, set by user. |
required |
query | string |
A user session query executed by the tile. |
required |
type | string |
The visualization of the tile.
|
required |
timeFrameShift | string |
The comparison timeframe of the query. If specified, you additionally get the results of the same query with the specified time shift. |
optional |
visualizationConfig | UserSessionQueryTileConfiguration | optional | |
limit | integer |
The limit of the results, if not set will use the default value of the system |
optional |
The UserSessionQueryTileConfiguration object
Configuration of a User session query visualization tile.
Element | Type | Description | Required |
---|---|---|---|
hasAxisBucketing | boolean |
The axis bucketing when enabled groups similar series in the same virtual axis. |
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 | optional |
The EntityShortRepresentation object
The short representation of a Dynatrace entity.
Element | Type | Description | Required |
---|---|---|---|
id | string |
The ID of the Dynatrace entity. |
required |
name | string |
The name of the Dynatrace entity. |
optional |
description | string |
A short description of the Dynatrace entity. |
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 |
{
"name": "User Sessions Query",
"tileType": "DTAQL",
"configured": true,
"bounds": {
"top": 112,
"left": 45,
"width": 304,
"height": 304
},
"tileFilter": {
"timeframe": "Today",
"managementZone": {
"id": "9130632296508575249",
"name": "Easytravel"
}
},
"customName": "User sessions query results",
"query": " SELECT country, city, COUNT(*) FROM usersession GROUP BY country, city",
"type": "COLUMN_CHART"
}