JSON models of dashboard tiles vary greatly, depending on the type of the tile. The JSON models for each tile type are listed below.
This type applies to the following tiles:
AWS
)BOUNCE_RATE
)CUSTOM_APPLICATION
)DATABASE
)SYNTHETIC_SINGLE_EXT_TEST
)SYNTHETIC_HTTP_MONITOR
)UEM_JSERRORS_OVERALL
)UEM_KEY_USER_ACTIONS
)DEM_KEY_USER_ACTION
)LOG_ANALYTICS
)MOBILE_APPLICATION
)SERVICE_VERSATILE
)SLO
)UEM_CONVERSIONS_OVERALL
)SESSION_METRICS
)USERS
)VIRTUALIZATION
)APPLICATION
)APPLICATION_METHOD
or APPLICATION_METHOD
)AssignedEntitiesTile
objectConfiguration of a tile with an assigned Dynatrace entity.
An example is the Bounce rate tile, showing the data from an assigned application.
Element | Type | Description |
---|---|---|
assignedEntities | string[] | The list of Dynatrace entities, assigned to the tile. |
This type applies to the following tiles:
APPLICATIONS
)DATABASES_OVERVIEW
)HOSTS
)SERVICES
)SYNTHETIC_TESTS
)FilterableEntityTile
objectConfiguration of a tile with the built-in custom filter.
An example is the Service health tile, which may use a custom timeframe.
Element | Type | Description |
---|---|---|
chartVisible | boolean | - |
filterConfig | Custom | Configuration of the custom filter of a tile. |
CustomFilterConfig
objectConfiguration of the custom filter of a tile.
Element | Type | Description |
---|---|---|
chartConfig | Custom | 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
|
CustomFilterChartConfig
objectConfiguration 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 | Custom | A list of charted metrics. |
type | string | The type of the chart.
|
CustomChartingItemMetadataConfig
objectAdditional 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. |
CustomFilterChartSeriesConfig
objectConfiguration of a charted metric.
Element | Type | Description |
---|---|---|
aggregation | string | The charted aggregation of the metric.
|
aggregationRate | string | -
|
dimensions | Custom | 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.
|
CustomFilterChartSeriesDimensionConfig
objectConfiguration 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. |
This type applies to the following tiles:
APPLICATION_WORLDMAP
)HOST
)PROCESS_GROUPS_ONE
)RESOURCES
)THIRD_PARTY_MOST_ACTIVE
)UEM_CONVERSIONS_PER_GOAL
)AssignedEntitiesWithMetricTile
objectConfiguration of a tile with an assigned Dynatrace entity and an assigned metric.
An example is the Worldmap tile, showing the data from an assigned performance or behavior metric of an assigned application.
Element | Type | Description |
---|---|---|
assignedEntities | string[] | The list of Dynatrace entities, assigned to the tile. |
metric | string | The metric assigned to the tile. |
This type applies to the following tiles:
DATA_EXPLORER
)DataExplorerTile
objectConfiguration of a data explorer tile.
Element | Type | Description |
---|---|---|
customName | string | The name of the tile, set by user. |
metricExpressions | string[] | The metric expressions generated by this configuration |
queries | Data | The list queries to explore |
queriesSettings | Data | Configuration for the queries |
visualConfig | Visualization | Configuration of a visualization. |
DataExplorerQuery
objectConfiguration 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 | Data | 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 | Data | TimeShift for data explorer queries. |
DataExplorerFilter
objectFilter for data explorer queries.
Element | Type | Description |
---|---|---|
criteria | Dexp | - |
entityAttribute | string | - |
filter | string | - |
filterOperator | string | -
|
filterType | string | -
|
globalEntity | string | - |
nestedFilters | Data | - |
relationship | Dexp | - |
DexpFilterCriterion
objectCriterion for data explorer filters.
Element | Type | Description |
---|---|---|
evaluator | string | -
|
matchExactly | boolean | - |
value | string | - |
DexpFilterRelationship
objectElement | 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
|
DataExplorerTimeShift
objectTimeShift for data explorer queries.
Element | Type | Description |
---|---|---|
factor | integer | - |
unit | string | -
|
DataExplorerQuerySettings
objectConfiguration for the queries
Element | Type | Description |
---|---|---|
foldAggregation | string | The fold aggregation
|
foldTransformation | string | The fold transformation
|
resolution | string | The resolution |
VisualizationConfiguration
objectConfiguration of a visualization.
Element | Type | Description |
---|---|---|
axes | Axes | Axes configuration |
global | Visualization | Visualization global configuration |
graphChartSettings | Graph | Settings for graph chart visualization |
heatmapSettings | Heatmap | Settings for heatmap visualization |
honeycombSettings | Honeycomb | Settings for honeycomb visualization |
rules | Visualization | Rules for Visualization |
singleValueSettings | Single | Settings for single value visualization |
tableSettings | Table | Settings for table visualization |
thresholds | Visualization | Thresholds for Visualization |
type | string | The id of the query
|
Axes
objectAxes configuration
Axis
objectx Axis configuration
Element | Type | Description |
---|---|---|
displayName | string | - |
visible | boolean | - |
YAxis
objecty Axes configuration
Element | Type | Description |
---|---|---|
defaultAxis | boolean | - |
displayName | string | - |
max | string | - |
min | string | - |
position | string | -
|
queryIds | string[] | - |
visible | boolean | - |
VisualizationGlobalProperties
objectVisualization global configuration
Element | Type | Description |
---|---|---|
hasTrendline | boolean | - |
hideLegend | boolean | - |
seriesType | string | -
|
theme | string | -
|
threshold | Visualization | Thresholds for Visualization |
VisualizationThreshold
objectThresholds for Visualization
Element | Type | Description |
---|---|---|
axisTarget | string | -
|
columnId | string | - |
queryId | string | - |
rules | Visualization | - |
visible | boolean | - |
VisualizationThresholdRule
objectElement | Type | Description |
---|---|---|
color | string | - |
value | number | - |
GraphChartSettings
objectSettings for graph chart visualization
Element | Type | Description |
---|---|---|
connectNulls | boolean | - |
HeatmapSettings
objectSettings 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 |
HoneycombSettings
objectSettings for honeycomb visualization
Element | Type | Description |
---|---|---|
showHive | boolean | - |
showLabels | boolean | - |
showLegend | boolean | - |
VisualizationRule
objectRules for Visualization
Element | Type | Description |
---|---|---|
matcher | string | - |
properties | Visualization | - |
seriesOverrides | Visualization | - |
unitTransform | string | - |
valueFormat | string | - |
VisualizationProperties
objectElement | Type | Description |
---|---|---|
alias | string | - |
color | string | - |
seriesType | string | -
|
VisualizationSerieOverride
objectElement | Type | Description |
---|---|---|
color | string | - |
name | string | - |
SingleValueSettings
objectSettings for single value visualization
Element | Type | Description |
---|---|---|
linkTileColorToThreshold | boolean | - |
showSparkLine | boolean | - |
showTrend | boolean | - |
TableSettings
objectSettings for table visualization
Element | Type | Description |
---|---|---|
hiddenColumns | string[] | - |
isThresholdBackgroundAppliedToCell | boolean | - |
This type applies to the following tiles:
CUSTOM_CHARTING
)CustomChartingTile
objectConfiguration of a custom chart tile.
Element | Type | Description |
---|---|---|
filterConfig | Custom | Configuration of the custom filter of a tile. |
CustomFilterConfig
objectConfiguration of the custom filter of a tile.
Element | Type | Description |
---|---|---|
chartConfig | Custom | 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
|
CustomFilterChartConfig
objectConfiguration 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 | Custom | A list of charted metrics. |
type | string | The type of the chart.
|
CustomChartingItemMetadataConfig
objectAdditional 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. |
CustomFilterChartSeriesConfig
objectConfiguration of a charted metric.
Element | Type | Description |
---|---|---|
aggregation | string | The charted aggregation of the metric.
|
aggregationRate | string | -
|
dimensions | Custom | 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.
|
CustomFilterChartSeriesDimensionConfig
objectConfiguration 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. |
This type applies to the following tiles:
MARKDOWN
)MarkdownTile
objectConfiguration of the Markdown tile.
Element | Type | Description |
---|---|---|
markdown | string | The markdown-formatted content of the tile. |
This type applies to the following tiles:
OPEN_PROBLEMS
)ProblemTile
objectConfiguration of a problem tile.
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
objectConfiguration of a tile with the built-in custom filter id. This is only for internal usage.
Element | Type | Description |
---|---|---|
chartVisible | boolean | - |
customFilterId | string | The ID of the custom filter. |
entitySpecificTileType | string | The type of the entity specific tile.
|
This type applies to the following tiles:
SYNTHETIC_SINGLE_WEBCHECK
)SyntheticSingleWebcheckTile
objectConfiguration of the Browser monitor tile.
Element | Type | Description |
---|---|---|
assignedEntities | string[] | The list of Dynatrace entities, assigned to the tile. |
excludeMaintenanceWindows | boolean | Include ( |
This type applies to the following tiles:
DCRUM_SERVICES
)DOCKER
)HEADER
)UEM_ACTIVE_SESSIONS
)NETWORK
)NETWORK_MEDIUM
)PURE_MODEL
)APPLICATIONS_MOST_ACTIVE
)Tile
objectConfiguration 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 | Tile | 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 | Tile | 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:
|
TileBounds
objectThe 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. |
TileFilter
objectA filter applied to a tile.
It overrides dashboard's filter.
Element | Type | Description |
---|---|---|
managementZone | Entity | The short representation of a Dynatrace entity. |
timeframe | string | The default timeframe of the tile. |
EntityShortRepresentation
objectThe 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. |
This type applies to the following tiles:
DTAQL
)UserSessionQueryTile
objectConfiguration of a User session query tile.
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 | User | Configuration of a User session query visualization tile. |
UserSessionQueryTileConfiguration
objectConfiguration 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. |