Dashboards API - Tile JSON models
JSON models of dashboard tiles vary greatly, depending on the type of the tile. The JSON models for each tile type are listed below.
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 overview (
UEM_KEY_USER_ACTIONS
) - Key user action (
DEM_KEY_USER_ACTION
) - Log event (
LOG_ANALYTICS
)
- Mobile app (
MOBILE_APPLICATION
) - Service or request (
SERVICE_VERSATILE
) - Service-level objective (
SLO
) - Top conversion goals (
UEM_CONVERSIONS_OVERALL
) - User behavior (
SESSION_METRICS
) - User breakdown (
USERS
) - VMware (
VIRTUALIZATION
) - Web application (
APPLICATION
) - User action (
APPLICATION_METHOD
orAPPLICATION_METHOD
)
The AssignedEntitiesTile
object
Configuration of a tile.
The actual set of fields depends on the type of the tile. Find the list of actual objects in the description of the tileType field or see Dashboards API - Tile JSON models.
Element | Type | Description |
---|---|---|
assignedEntities | string[] | The list of Dynatrace entities, assigned to the tile. |
FilterableEntityTile
This type applies to the following tiles:
- Application health (
APPLICATIONS
) - Database health (
DATABASES_OVERVIEW
) - Host health (
HOSTS
) - Service health (
SERVICES
) - Synthetic monitor health (
SYNTHETIC_TESTS
)
The FilterableEntityTile
object
Configuration of a tile.
The actual set of fields depends on the type of the tile. Find the list of actual objects in the description of the tileType field or see Dashboards API - Tile JSON models.
Element | Type | Description |
---|---|---|
chartVisible | boolean | - |
filterConfig | CustomFilterConfig | Configuration of the custom filter of a tile. |
The CustomFilterConfig
object
Configuration of the custom filter of a tile.
Element | Type | Description |
---|---|---|
chartConfig | CustomFilterChartConfig | Configuration of a custom chart. |
customName | string | The name of the tile, set by user |
defaultName | string | The default name of the tile |
filtersPerEntityType | object | A list of filters, applied to specific entity types. |
type | string | The type of the filter. It shows to which entity the filter belongs. Custom charts have the
|
The CustomFilterChartConfig
object
Configuration of a custom chart.
Element | Type | Description |
---|---|---|
axisLimits | object | The optional custom y-axis limits. |
leftAxisCustomUnit | string | The custom unit for the left Y-axis.
|
legendShown | boolean | Defines if a legend should be shown. |
resultMetadata | object | Additional information about charted metric. |
rightAxisCustomUnit | string | The custom unit for the right Y-axis.
|
series | CustomFilterChartSeriesConfig[] | A list of charted metrics. |
type | string | The type of the chart.
|
The CustomChartingItemMetadataConfig
object
Additional metadata for charted metric.
Element | Type | Description |
---|---|---|
customColor | string | The color of the metric in the chart, hex format. |
lastModified | integer | The timestamp of the last metadata modification, in UTC milliseconds. |
The CustomFilterChartSeriesConfig
object
Configuration of a charted metric.
Element | Type | Description |
---|---|---|
aggregation | string | The charted aggregation of the metric.
|
aggregationRate | string | -
|
dimensions | CustomFilterChartSeriesDimensionConfig[] | Configuration of the charted metric splitting. |
entityType | string | The type of the Dynatrace entity that delivered the charted metric. |
metric | string | The name of the charted metric. |
percentile | integer | The charted percentile. Only applicable if the aggregation is set to |
sortAscending | boolean | Sort ascending ( |
sortColumn | boolean | - |
type | string | The visualization of the timeseries chart.
|
The CustomFilterChartSeriesDimensionConfig
object
Configuration of the charted metric splitting.
Element | Type | Description |
---|---|---|
entityDimension | boolean | - |
id | string | The ID of the dimension by which the metric is split. |
name | string | The name of the dimension by which the metric is split. |
values | string[] | The splitting value. |
AssignedEntitiesWithMetricTile
This type applies to the following tiles:
- World map (
APPLICATION_WORLDMAP
) - Host (
HOST
) - Process group (
PROCESS_GROUPS_ONE
) - Resources (
RESOURCES
) - 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. Find the list of actual objects in the description of the tileType field or see Dashboards API - Tile JSON models.
Element | Type | Description |
---|---|---|
assignedEntities | string[] | The list of Dynatrace entities, assigned to the tile. |
metric | string | The metric assigned to the tile. |
DataExplorerTile
This type applies to the following tiles:
- Data explorer tile (
DATA_EXPLORER
)
The DataExplorerTile
object
Configuration of a tile.
The actual set of fields depends on the type of the tile. Find the list of actual objects in the description of the tileType field or see Dashboards API - Tile JSON models.
Element | Type | Description |
---|---|---|
customName | string | The name of the tile, set by user. |
metricExpressions | string[] | The metric expressions generated by this configuration |
queries | DataExplorerQuery[] | The list queries to explore |
queriesSettings | DataExplorerQuerySettings | Configuration for the queries |
visualConfig | VisualizationConfiguration | Configuration of a visualization. |
The DataExplorerQuery
object
Configuration of a data explorer query.
Element | Type | Description |
---|---|---|
defaultValue | number | Replaces null data points with the provided value |
enabled | boolean | Status of the query |
filterBy | DataExplorerFilter | Filter for data explorer queries. |
foldTransformation | string | The fold transformation
|
generatedMetricSelector | string | Generated metric selector |
id | string | The id of the query |
limit | integer | Limit the results of the query |
metric | string | The metric id |
metricSelector | string | The metric selector |
rate | string | Converts a count-based metric (for example, bytes) into a rate-based metric (bytes per second)
|
sortBy | string | The order of the sorting applied to the query
|
sortByDimension | string | The dimension where sorting is applied. Sorting by value if null |
spaceAggregation | string | Space aggregation applied to the query
|
splitBy | string[] | The splittings applied to the query |
timeAggregation | string | Time roll up applied to the query
|
timeShift | DataExplorerTimeShift | TimeShift for data explorer queries. |
The DataExplorerFilter
object
Filter for data explorer queries.
Element | Type | Description |
---|---|---|
criteria | DexpFilterCriterion[] | - |
entityAttribute | string | - |
filter | string | - |
filterOperator | string | -
|
filterType | string | -
|
globalEntity | string | - |
nestedFilters | DataExplorerFilter[] | - |
relationship | DexpFilterRelationship | - |
The DexpFilterCriterion
object
Criterion for data explorer filters.
Element | Type | Description |
---|---|---|
evaluator | string | -
|
matchExactly | boolean | - |
value | string | - |
The DexpFilterRelationship
object
Element | Type | Description |
---|---|---|
id | string | The id of the relationship. e.g runsOn, isStepOf, etc |
targetEntity | string | The target entity of the relationship. e.g HOST, VCENTER, SERVICE etc |
type | string | The type of the relationship
|
The DataExplorerTimeShift
object
TimeShift for data explorer queries.
Element | Type | Description |
---|---|---|
factor | integer | - |
unit | string | -
|
The DataExplorerQuerySettings
object
Configuration for the queries
Element | Type | Description |
---|---|---|
foldAggregation | string | The fold aggregation
|
foldTransformation | string | The fold transformation
|
resolution | string | The resolution |
The VisualizationConfiguration
object
Configuration of a visualization.
Element | Type | Description |
---|---|---|
axes | Axes | Axes configuration |
global | VisualizationGlobalProperties | Visualization global configuration |
graphChartSettings | GraphChartSettings | Settings for graph chart visualization |
heatmapSettings | HeatmapSettings | Settings for heatmap visualization |
honeycombSettings | HoneycombSettings | Settings for honeycomb visualization |
rules | VisualizationRule[] | Rules for Visualization |
singleValueSettings | SingleValueSettings | Settings for single value visualization |
tableSettings | TableSettings | Settings for table visualization |
thresholds | VisualizationThreshold[] | Thresholds for Visualization |
type | string | The id of the query
|
The Axes
object
Axes configuration
The Axis
object
x Axis configuration
Element | Type | Description |
---|---|---|
displayName | string | - |
visible | boolean | - |
The YAxis
object
y Axes configuration
Element | Type | Description |
---|---|---|
defaultAxis | boolean | - |
displayName | string | - |
max | string | - |
min | string | - |
position | string | -
|
queryIds | string[] | - |
visible | boolean | - |
The VisualizationGlobalProperties
object
Visualization global configuration
Element | Type | Description |
---|---|---|
hasTrendline | boolean | - |
hideLegend | boolean | - |
seriesType | string | -
|
theme | string | -
|
threshold | VisualizationThreshold | Thresholds for Visualization |
The VisualizationThreshold
object
Thresholds for Visualization
Element | Type | Description |
---|---|---|
axisTarget | string | -
|
columnId | string | - |
queryId | string | - |
rules | VisualizationThresholdRule[] | - |
visible | boolean | - |
The VisualizationThresholdRule
object
Element | Type | Description |
---|---|---|
color | string | - |
value | number | - |
The GraphChartSettings
object
Settings for graph chart visualization
Element | Type | Description |
---|---|---|
connectNulls | boolean | - |
The HeatmapSettings
object
Settings for heatmap visualization
Element | Type | Description |
---|---|---|
showLabels | boolean | - |
xAxisBuckets | integer | Number of buckets in the X axis |
yAxis | string | Y axis aggregation criteria
|
yAxisBuckets | integer | Number of buckets in the Y axis |
The HoneycombSettings
object
Settings for honeycomb visualization
Element | Type | Description |
---|---|---|
showHive | boolean | - |
showLabels | boolean | - |
showLegend | boolean | - |
The VisualizationRule
object
Rules for Visualization
Element | Type | Description |
---|---|---|
matcher | string | - |
properties | VisualizationProperties | - |
seriesOverrides | VisualizationSerieOverride[] | - |
unitTransform | string | - |
valueFormat | string | - |
The VisualizationProperties
object
Element | Type | Description |
---|---|---|
alias | string | - |
color | string | - |
seriesType | string | -
|
The VisualizationSerieOverride
object
Element | Type | Description |
---|---|---|
color | string | - |
name | string | - |
The SingleValueSettings
object
Settings for single value visualization
Element | Type | Description |
---|---|---|
linkTileColorToThreshold | boolean | - |
showSparkLine | boolean | - |
showTrend | boolean | - |
The TableSettings
object
Settings for table visualization
Element | Type | Description |
---|---|---|
hiddenColumns | string[] | - |
isThresholdBackgroundAppliedToCell | boolean | - |
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. Find the list of actual objects in the description of the tileType field or see Dashboards API - Tile JSON models.
Element | Type | Description |
---|---|---|
filterConfig | CustomFilterConfig | Configuration of the custom filter of a tile. |
The CustomFilterConfig
object
Configuration of the custom filter of a tile.
Element | Type | Description |
---|---|---|
chartConfig | CustomFilterChartConfig | Configuration of a custom chart. |
customName | string | The name of the tile, set by user |
defaultName | string | The default name of the tile |
filtersPerEntityType | object | A list of filters, applied to specific entity types. |
type | string | The type of the filter. It shows to which entity the filter belongs. Custom charts have the
|
The CustomFilterChartConfig
object
Configuration of a custom chart.
Element | Type | Description |
---|---|---|
axisLimits | object | The optional custom y-axis limits. |
leftAxisCustomUnit | string | The custom unit for the left Y-axis.
|
legendShown | boolean | Defines if a legend should be shown. |
resultMetadata | object | Additional information about charted metric. |
rightAxisCustomUnit | string | The custom unit for the right Y-axis.
|
series | CustomFilterChartSeriesConfig[] | A list of charted metrics. |
type | string | The type of the chart.
|
The CustomChartingItemMetadataConfig
object
Additional metadata for charted metric.
Element | Type | Description |
---|---|---|
customColor | string | The color of the metric in the chart, hex format. |
lastModified | integer | The timestamp of the last metadata modification, in UTC milliseconds. |
The CustomFilterChartSeriesConfig
object
Configuration of a charted metric.
Element | Type | Description |
---|---|---|
aggregation | string | The charted aggregation of the metric.
|
aggregationRate | string | -
|
dimensions | CustomFilterChartSeriesDimensionConfig[] | Configuration of the charted metric splitting. |
entityType | string | The type of the Dynatrace entity that delivered the charted metric. |
metric | string | The name of the charted metric. |
percentile | integer | The charted percentile. Only applicable if the aggregation is set to |
sortAscending | boolean | Sort ascending ( |
sortColumn | boolean | - |
type | string | The visualization of the timeseries chart.
|
The CustomFilterChartSeriesDimensionConfig
object
Configuration of the charted metric splitting.
Element | Type | Description |
---|---|---|
entityDimension | boolean | - |
id | string | The ID of the dimension by which the metric is split. |
name | string | The name of the dimension by which the metric is split. |
values | string[] | The splitting value. |
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. Find the list of actual objects in the description of the tileType field or see Dashboards API - Tile JSON models.
Element | Type | Description |
---|---|---|
markdown | string | The markdown-formatted content of the tile. |
ProblemTile
This type applies to the following tiles:
- Problems (
OPEN_PROBLEMS
)
The ProblemTile
object
Configuration of a tile.
The actual set of fields depends on the type of the tile. Find the list of actual objects in the description of the tileType field or see Dashboards API - Tile JSON models.
Element | Type | Description |
---|---|---|
entitySelector | string | The entity scope of the problem tile. For further information please look at the Problems API v2 '/problems' endpoint. |
problemSelector | string | Defines the scope of the problem tile. Only problems matching the specified criteria are taken into account. For further information please look at the Problems API v2 '/problems' endpoint. |
useBackgroundColor | boolean | Use background color based on problem status: Red if there are open problems, green otherwise. |
ScalableListTile
The ScalableListTile
object
Configuration of a tile.
The actual set of fields depends on the type of the tile. Find the list of actual objects in the description of the tileType field or see Dashboards API - Tile JSON models.
Element | Type | Description |
---|---|---|
chartVisible | boolean | - |
customFilterId | string | The ID of the custom filter. |
entitySpecificTileType | string | The type of the entity specific tile.
|
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. Find the list of actual objects in the description of the tileType field or see Dashboards API - Tile JSON models.
Element | Type | Description |
---|---|---|
assignedEntities | string[] | The list of Dynatrace entities, assigned to the tile. |
excludeMaintenanceWindows | boolean | Include ( |
Tile
This type applies to the following tiles:
- Data center services health (
DCRUM_SERVICES
) - Docker (
DOCKER
) - Header (
HEADER
) - Live user activity (
UEM_ACTIVE_SESSIONS
) - Network metric (
NETWORK
) - Network status (
NETWORK_MEDIUM
) - Smartscape (
PURE_MODEL
) - Top web applications (
APPLICATIONS_MOST_ACTIVE
)
The Tile
object
Configuration of a tile.
The actual set of fields depends on the type of the tile. Find the list of actual objects in the description of the tileType field or see Dashboards API - Tile JSON models.
Element | Type | Description |
---|---|---|
bounds | TileBounds | The position and size of a tile. |
configured | boolean | The tile is configured and ready to use ( |
isAutoRefreshDisabled | boolean | The tile auto refresh is disabled. Only works for certain tile types. |
name | string | The name of the tile. |
nameSize | string | The size of the tile name. Default value is null.
|
tileFilter | TileFilter | A filter applied to a tile. It overrides dashboard's filter. |
tileType | string | Defines the actual set of fields depending on the value. See one of the following objects:
|
The TileBounds
object
The position and size of a tile.
Element | Type | Description |
---|---|---|
height | integer | The height 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. |
top | integer | The vertical 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. |
The TileFilter
object
A filter applied to a tile.
It overrides dashboard's filter.
Element | Type | Description |
---|---|---|
managementZone | EntityShortRepresentation | The short representation of a Dynatrace entity. |
timeframe | string | The default timeframe of the tile. |
The EntityShortRepresentation
object
The short representation of a Dynatrace entity.
Element | Type | Description |
---|---|---|
description | string | A short description of the Dynatrace entity. |
id | string | The ID of the Dynatrace entity. |
name | string | The name of the Dynatrace entity. |
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. Find the list of actual objects in the description of the tileType field or see Dashboards API - Tile JSON models.
Element | Type | Description |
---|---|---|
customName | string | The name of the tile, set by user. |
limit | integer | The limit of the results, if not set will use the default value of the system |
query | string | A user session query executed by the tile. |
timeFrameShift | string | The comparison timeframe of the query. If specified, you additionally get the results of the same query with the specified time shift. |
type | string | The visualization of the tile.
|
visualizationConfig | UserSessionQueryTileConfiguration | Configuration of a User session query visualization tile. |
The UserSessionQueryTileConfiguration
object
Configuration of a User session query visualization tile.
Element | Type | Description |
---|---|---|
hasAxisBucketing | boolean | The axis bucketing when enabled groups similar series in the same virtual axis. |