• Home
  • Dynatrace API
  • Configuration
  • Dashboards
  • Tile JSON models

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 or APPLICATION_METHOD)
AssignedEntitiesTile

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.

ElementTypeDescription
assignedEntitiesstring[]

The list of Dynatrace entities, assigned to the tile.

json
{ "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)
  • Database health (DATABASES_OVERVIEW)
  • Host health (HOSTS)
  • Service health (SERVICES)
  • Synthetic monitor health (SYNTHETIC_TESTS)
FilterableEntityTile

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.

ElementTypeDescription
filterConfigCustomFilterConfig

Configuration of the custom filter of a tile.

chartVisibleboolean-

The CustomFilterConfig object

Configuration of the custom filter of a tile.

ElementTypeDescription
typestring

The type of the filter.

It shows to which entity the filter belongs.

Custom charts have the MIXED type.

The element can hold these values
  • ALB
  • APPLICATION
  • APPLICATION_METHOD
  • APPMON
  • ASG
  • AWS_CREDENTIALS
  • AWS_CUSTOM_SERVICE
  • AWS_LAMBDA_FUNCTION
  • CLOUD_APPLICATION
  • CLOUD_APPLICATION_INSTANCE
  • CLOUD_APPLICATION_NAMESPACE
  • CONTAINER_GROUP_INSTANCE
  • CUSTOM_APPLICATION
  • CUSTOM_DEVICES
  • CUSTOM_SERVICES
  • DATABASE
  • DATABASE_KEY_REQUEST
  • DCRUM_APPLICATION
  • DCRUM_ENTITY
  • DYNAMO_DB
  • EBS
  • EC2
  • ELB
  • ENVIRONMENT
  • ESXI
  • EXTERNAL_SYNTHETIC_TEST
  • GLOBAL_BACKGROUND_ACTIVITY
  • HOST
  • IOT
  • KUBERNETES_CLUSTER
  • KUBERNETES_NODE
  • MDA_SERVICE
  • MIXED
  • MOBILE_APPLICATION
  • MONITORED_ENTITY
  • NLB
  • PG_BACKGROUND_ACTIVITY
  • PROBLEM
  • PROCESS_GROUP_INSTANCE
  • RDS
  • REMOTE_PLUGIN
  • SERVICE
  • SERVICE_KEY_REQUEST
  • SYNTHETIC_BROWSER_MONITOR
  • SYNTHETIC_HTTPCHECK
  • SYNTHETIC_HTTPCHECK_STEP
  • SYNTHETIC_LOCATION
  • SYNTHETIC_TEST
  • SYNTHETIC_TEST_STEP
  • UI_ENTITY
  • VIRTUAL_MACHINE
  • WEB_CHECK
customNamestring

The name of the tile, set by user

defaultNamestring

The default name of the tile

chartConfigCustomFilterChartConfig

Configuration of a custom chart.

filtersPerEntityTypeobject

A list of filters, applied to specific entity types.

The CustomFilterChartConfig object

Configuration of a custom chart.

ElementTypeDescription
legendShownboolean

Defines if a legend should be shown.

typestring

The type of the chart.

The element can hold these values
  • PIE
  • SINGLE_VALUE
  • TIMESERIES
  • TOP_LIST
seriesCustomFilterChartSeriesConfig[]

A list of charted metrics.

resultMetadataobject

Additional information about charted metric.

axisLimitsobject

The optional custom y-axis limits.

leftAxisCustomUnitstring

The custom unit for the left Y-axis.

The element can hold these values
  • Billion
  • Bit
  • BitPerHour
  • BitPerMinute
  • BitPerSecond
  • Byte
  • BytePerHour
  • BytePerMinute
  • BytePerSecond
  • Cores
  • Count
  • Day
  • DecibelMilliWatt
  • GibiByte
  • GibiBytePerHour
  • GibiBytePerMinute
  • GibiBytePerSecond
  • Giga
  • GigaByte
  • GigaBytePerHour
  • GigaBytePerMinute
  • GigaBytePerSecond
  • Hour
  • KibiByte
  • KibiBytePerHour
  • KibiBytePerMinute
  • KibiBytePerSecond
  • Kilo
  • KiloByte
  • KiloBytePerHour
  • KiloBytePerMinute
  • KiloBytePerSecond
  • KiloMetrePerHour
  • MSU
  • MebiByte
  • MebiBytePerHour
  • MebiBytePerMinute
  • MebiBytePerSecond
  • Mega
  • MegaByte
  • MegaBytePerHour
  • MegaBytePerMinute
  • MegaBytePerSecond
  • MetrePerHour
  • MetrePerSecond
  • MicroSecond
  • MilliCores
  • MilliSecond
  • MilliSecondPerMinute
  • Million
  • Minute
  • Month
  • NanoSecond
  • NanoSecondPerMinute
  • NotApplicable
  • PerHour
  • PerMinute
  • PerSecond
  • Percent
  • Pixel
  • Promille
  • Ratio
  • Second
  • State
  • Trillion
  • Unspecified
  • Week
  • Year
rightAxisCustomUnitstring

The custom unit for the right Y-axis.

The element can hold these values
  • Billion
  • Bit
  • BitPerHour
  • BitPerMinute
  • BitPerSecond
  • Byte
  • BytePerHour
  • BytePerMinute
  • BytePerSecond
  • Cores
  • Count
  • Day
  • DecibelMilliWatt
  • GibiByte
  • GibiBytePerHour
  • GibiBytePerMinute
  • GibiBytePerSecond
  • Giga
  • GigaByte
  • GigaBytePerHour
  • GigaBytePerMinute
  • GigaBytePerSecond
  • Hour
  • KibiByte
  • KibiBytePerHour
  • KibiBytePerMinute
  • KibiBytePerSecond
  • Kilo
  • KiloByte
  • KiloBytePerHour
  • KiloBytePerMinute
  • KiloBytePerSecond
  • KiloMetrePerHour
  • MSU
  • MebiByte
  • MebiBytePerHour
  • MebiBytePerMinute
  • MebiBytePerSecond
  • Mega
  • MegaByte
  • MegaBytePerHour
  • MegaBytePerMinute
  • MegaBytePerSecond
  • MetrePerHour
  • MetrePerSecond
  • MicroSecond
  • MilliCores
  • MilliSecond
  • MilliSecondPerMinute
  • Million
  • Minute
  • Month
  • NanoSecond
  • NanoSecondPerMinute
  • NotApplicable
  • PerHour
  • PerMinute
  • PerSecond
  • Percent
  • Pixel
  • Promille
  • Ratio
  • Second
  • State
  • Trillion
  • Unspecified
  • Week
  • Year

The CustomFilterChartSeriesConfig object

Configuration of a charted metric.

ElementTypeDescription
metricstring

The name of the charted metric.

aggregationstring

The charted aggregation of the metric.

The element can hold these values
  • AVG
  • COUNT
  • DISTINCT
  • FASTEST10PERCENT
  • MAX
  • MEDIAN
  • MIN
  • NONE
  • OF_INTEREST_RATIO
  • OTHER_RATIO
  • PERCENTILE
  • PER_MIN
  • SLOWEST10PERCENT
  • SLOWEST5PERCENT
  • SUM
  • SUM_DIMENSIONS
percentileinteger

The charted percentile.

Only applicable if the aggregation is set to PERCENTILE.

typestring

The visualization of the timeseries chart.

The element can hold these values
  • AREA
  • BAR
  • LINE
entityTypestring

The type of the Dynatrace entity that delivered the charted metric.

dimensionsCustomFilterChartSeriesDimensionConfig[]

Configuration of the charted metric splitting.

sortAscendingboolean

Sort ascending (true) or descending (false).

sortColumnboolean-
aggregationRatestring-
The element can hold these values
  • HOUR
  • MINUTE
  • SECOND
  • TOTAL

The CustomFilterChartSeriesDimensionConfig object

Configuration of the charted metric splitting.

ElementTypeDescription
idstring

The ID of the dimension by which the metric is split.

namestring

The name of the dimension by which the metric is split.

valuesstring[]

The splitting value.

entityDimensionboolean-

The CustomChartingItemMetadataConfig object

Additional metadata for charted metric.

ElementTypeDescription
lastModifiedinteger

The timestamp of the last metadata modification, in UTC milliseconds.

customColorstring

The color of the metric in the chart, hex format.

json
{ "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)
  • Host (HOST)
  • Process group (PROCESS_GROUPS_ONE)
  • Resources (RESOURCES)
  • Most used 3rd parties (THIRD_PARTY_MOST_ACTIVE)
  • Conversion goal (UEM_CONVERSIONS_PER_GOAL)
AssignedEntitiesWithMetricTile

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.

ElementTypeDescription
assignedEntitiesstring[]

The list of Dynatrace entities, assigned to the tile.

metricstring

The metric assigned to the tile.

json
{ "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" }

DataExplorerTile

This type applies to the following tiles:

  • Data explorer tile (DATA_EXPLORER)
DataExplorerTile

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.

ElementTypeDescription
customNamestring

The name of the tile, set by user.

queriesDataExplorerQuery[]

The list queries to explore

visualConfigVisualizationConfiguration

Configuration of a visualization.

queriesSettingsDataExplorerQuerySettings

Configuration for the queries

metricExpressionsstring[]

The metric expressions generated by this configuration

The DataExplorerQuery object

Configuration of a data explorer query.

ElementTypeDescription
idstring

The id of the query

metricstring

The metric id

spaceAggregationstring

Space aggregation applied to the query

The element can hold these values
  • AUTO
  • AVG
  • COUNT
  • MAX
  • MEDIAN
  • MIN
  • PERCENTILE_10
  • PERCENTILE_75
  • PERCENTILE_90
  • SUM
  • VALUE
timeAggregationstring

Time roll up applied to the query

The element can hold these values
  • AVG
  • COUNT
  • DEFAULT
  • MAX
  • MEDIAN
  • MIN
  • SUM
  • VALUE
splitBystring[]

The splittings applied to the query

sortBystring

The order of the sorting applied to the query

The element can hold these values
  • ASC
  • DESC
sortByDimensionstring

The dimension where sorting is applied. Sorting by value if null

filterByDataExplorerFilter

Filter for data explorer queries.

limitinteger

Limit the results of the query

metricSelectorstring

The metric selector

foldTransformationstring

The fold transformation

The element can hold these values
  • LAST_VALUE
  • TOTAL
defaultValuenumber

Replaces null data points with the provided value

ratestring

Converts a count-based metric (for example, bytes) into a rate-based metric (bytes per second)

The element can hold these values
  • HOUR
  • MINUTE
  • MONTH
  • NONE
  • SECOND
  • WEEK
  • YEAR
enabledboolean

Status of the query

generatedMetricSelectorstring

Generated metric selector

timeShiftDataExplorerTimeShift

TimeShift for data explorer queries.

The DataExplorerFilter object

Filter for data explorer queries.

ElementTypeDescription
filterstring-
globalEntitystring-
filterTypestring-
The element can hold these values
  • DIMENSION
  • ENTITY_ATTRIBUTE
  • ID
  • NAME
  • TAG
filterOperatorstring-
The element can hold these values
  • AND
  • NOT
  • OR
entityAttributestring-
relationshipDexpFilterRelationship-
nestedFiltersDataExplorerFilter[]-
criteriaDexpFilterCriterion[]-

The DexpFilterRelationship object

ElementTypeDescription
targetEntitystring

The target entity of the relationship. e.g HOST, VCENTER, SERVICE etc

idstring

The id of the relationship. e.g runsOn, isStepOf, etc

typestring

The type of the relationship

The element can hold these values
  • fromRelationship
  • toRelationship

The DexpFilterCriterion object

Criterion for data explorer filters.

ElementTypeDescription
valuestring-
evaluatorstring-
The element can hold these values
  • EQ
  • IN
  • NE
  • PREFIX
matchExactlyboolean-

The DataExplorerTimeShift object

TimeShift for data explorer queries.

ElementTypeDescription
factorinteger-
unitstring-
The element can hold these values
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • WEEK

The VisualizationConfiguration object

Configuration of a visualization.

ElementTypeDescription
typestring

The id of the query

The element can hold these values
  • GRAPH_CHART
  • HEATMAP
  • HONEYCOMB
  • PIE_CHART
  • SINGLE_VALUE
  • STACKED_AREA
  • STACKED_COLUMN
  • TABLE
  • TOP_LIST
globalVisualizationGlobalProperties

Visualization global configuration

rulesVisualizationRule[]

Rules for Visualization

axesAxes

Axes configuration

heatmapSettingsHeatmapSettings

Settings for heatmap visualization

singleValueSettingsSingleValueSettings

Settings for single value visualization

thresholdsVisualizationThreshold[]

Thresholds for Visualization

tableSettingsTableSettings

Settings for table visualization

graphChartSettingsGraphChartSettings

Settings for graph chart visualization

honeycombSettingsHoneycombSettings

Settings for honeycomb visualization

The VisualizationGlobalProperties object

Visualization global configuration

ElementTypeDescription
themestring-
The element can hold these values
  • BLUE
  • DEFAULT
  • GRAY
  • GREEN
  • ORANGE
  • PURPLE
  • RED
  • ROYALBLUE
  • TURQUOISE
  • YELLOW
hasTrendlineboolean-
seriesTypestring-
The element can hold these values
  • AREA
  • COLUMN
  • LINE
  • STACKED_AREA
  • STACKED_COLUMN
hideLegendboolean-
thresholdVisualizationThreshold

Thresholds for Visualization

The VisualizationThreshold object

Thresholds for Visualization

ElementTypeDescription
axisTargetstring-
The element can hold these values
  • LEFT
  • RIGHT
columnIdstring-
queryIdstring-
visibleboolean-
rulesVisualizationThresholdRule[]-

The VisualizationThresholdRule object

ElementTypeDescription
valuenumber-
colorstring-

The VisualizationRule object

Rules for Visualization

ElementTypeDescription
valueFormatstring-
seriesOverridesVisualizationSerieOverride[]-
unitTransformstring-
propertiesVisualizationProperties-
matcherstring-

The VisualizationSerieOverride object

ElementTypeDescription
namestring-
colorstring-

The VisualizationProperties object

ElementTypeDescription
seriesTypestring-
The element can hold these values
  • AREA
  • COLUMN
  • LINE
  • STACKED_AREA
  • STACKED_COLUMN
colorstring-
aliasstring-

The Axes object

Axes configuration

ElementTypeDescription
yAxesYAxis[]

y Axes configuration

xAxisAxis

x Axis configuration

The YAxis object

y Axes configuration

ElementTypeDescription
queryIdsstring[]-
defaultAxisboolean-
minstring-
positionstring-
The element can hold these values
  • LEFT
  • RIGHT
maxstring-
displayNamestring-
visibleboolean-

The Axis object

x Axis configuration

ElementTypeDescription
displayNamestring-
visibleboolean-

The HeatmapSettings object

Settings for heatmap visualization

ElementTypeDescription
yAxisstring

Y axis aggregation criteria

The element can hold these values
  • DIMENSIONS
  • VALUE
yAxisBucketsinteger

Number of buckets in the Y axis

xAxisBucketsinteger

Number of buckets in the X axis

showLabelsboolean-

The SingleValueSettings object

Settings for single value visualization

ElementTypeDescription
showTrendboolean-
showSparkLineboolean-
linkTileColorToThresholdboolean-

The TableSettings object

Settings for table visualization

ElementTypeDescription
isThresholdBackgroundAppliedToCellboolean-

The GraphChartSettings object

Settings for graph chart visualization

ElementTypeDescription
connectNullsboolean-

The HoneycombSettings object

Settings for honeycomb visualization

ElementTypeDescription
showHiveboolean-
showLegendboolean-
showLabelsboolean-

The DataExplorerQuerySettings object

Configuration for the queries

ElementTypeDescription
resolutionstring

The resolution

foldTransformationstring

The fold transformation

The element can hold these values
  • LAST_VALUE
  • TOTAL
foldAggregationstring

The fold aggregation

The element can hold these values
  • AUTO
  • AVG
  • COUNT
  • MAX
  • MEDIAN
  • MIN
  • PERCENTILE_10
  • PERCENTILE_75
  • PERCENTILE_90
  • SUM
  • VALUE
json
{ "name": "Data explorer results", "tileType": "DATA_EXPLORER", "configured": true, "bounds": { "top": 0, "left": 0, "width": 304, "height": 304 }, "tileFilter": {}, "customName": "Data explorer results", "queries": [ { "id": "A", "metric": "builtin:host.cpu.usage", "timeAggregation": "DEFAULT", "splitBy": [ "dt.entity.host" ], "sortBy": "DESC", "filterBy": { "filterOperator": "AND", "nestedFilters": [], "criteria": [] }, "limit": 100, "enabled": true } ], "visualConfig": { "type": "GRAPH_CHART", "global": { "hideLegend": false }, "rules": [ { "matcher": "A:", "unitTransform": "Promille", "valueFormat": "0,00", "properties": { "color": "DEFAULT", "seriesType": "LINE" }, "seriesOverrides": [] } ], "axes": { "xAxis": { "displayName": "", "visible": true }, "yAxes": [ { "displayName": "", "visible": true, "min": "AUTO", "max": "AUTO", "position": "LEFT", "queryIds": [ "A" ], "defaultAxis": true } ] }, "heatmapSettings": { "yAxis": "VALUE" }, "singleValueSettings": { "showSparkLine": false }, "thresholds": [ { "axisTarget": "LEFT", "rules": [ { "color": "#7dc540" }, { "color": "#f5d30f" }, { "value": 50, "color": "#dc172a" } ], "queryId": "", "visible": true } ], "tableSettings": { "isThresholdBackgroundAppliedToCell": false }, "graphChartSettings": { "connectNulls": true }, "honeycombSettings": { "showHive": true, "showLegend": true, "showLabels": false } }, "queriesSettings": { "resolution": "" }, "metricExpressions": [ "resolution=null&(builtin:host.cpu.usage:splitBy(\"dt.entity.host\"):sort(value(auto,descending)):limit(100)):limit(100):names" ] }

CustomChartingTile

This type applies to the following tiles:

  • Custom chart (CUSTOM_CHARTING)
CustomChartingTile

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.

ElementTypeDescription
filterConfigCustomFilterConfig

Configuration of the custom filter of a tile.

The CustomFilterConfig object

Configuration of the custom filter of a tile.

ElementTypeDescription
typestring

The type of the filter.

It shows to which entity the filter belongs.

Custom charts have the MIXED type.

The element can hold these values
  • ALB
  • APPLICATION
  • APPLICATION_METHOD
  • APPMON
  • ASG
  • AWS_CREDENTIALS
  • AWS_CUSTOM_SERVICE
  • AWS_LAMBDA_FUNCTION
  • CLOUD_APPLICATION
  • CLOUD_APPLICATION_INSTANCE
  • CLOUD_APPLICATION_NAMESPACE
  • CONTAINER_GROUP_INSTANCE
  • CUSTOM_APPLICATION
  • CUSTOM_DEVICES
  • CUSTOM_SERVICES
  • DATABASE
  • DATABASE_KEY_REQUEST
  • DCRUM_APPLICATION
  • DCRUM_ENTITY
  • DYNAMO_DB
  • EBS
  • EC2
  • ELB
  • ENVIRONMENT
  • ESXI
  • EXTERNAL_SYNTHETIC_TEST
  • GLOBAL_BACKGROUND_ACTIVITY
  • HOST
  • IOT
  • KUBERNETES_CLUSTER
  • KUBERNETES_NODE
  • MDA_SERVICE
  • MIXED
  • MOBILE_APPLICATION
  • MONITORED_ENTITY
  • NLB
  • PG_BACKGROUND_ACTIVITY
  • PROBLEM
  • PROCESS_GROUP_INSTANCE
  • RDS
  • REMOTE_PLUGIN
  • SERVICE
  • SERVICE_KEY_REQUEST
  • SYNTHETIC_BROWSER_MONITOR
  • SYNTHETIC_HTTPCHECK
  • SYNTHETIC_HTTPCHECK_STEP
  • SYNTHETIC_LOCATION
  • SYNTHETIC_TEST
  • SYNTHETIC_TEST_STEP
  • UI_ENTITY
  • VIRTUAL_MACHINE
  • WEB_CHECK
customNamestring

The name of the tile, set by user

defaultNamestring

The default name of the tile

chartConfigCustomFilterChartConfig

Configuration of a custom chart.

filtersPerEntityTypeobject

A list of filters, applied to specific entity types.

The CustomFilterChartConfig object

Configuration of a custom chart.

ElementTypeDescription
legendShownboolean

Defines if a legend should be shown.

typestring

The type of the chart.

The element can hold these values
  • PIE
  • SINGLE_VALUE
  • TIMESERIES
  • TOP_LIST
seriesCustomFilterChartSeriesConfig[]

A list of charted metrics.

resultMetadataobject

Additional information about charted metric.

axisLimitsobject

The optional custom y-axis limits.

leftAxisCustomUnitstring

The custom unit for the left Y-axis.

The element can hold these values
  • Billion
  • Bit
  • BitPerHour
  • BitPerMinute
  • BitPerSecond
  • Byte
  • BytePerHour
  • BytePerMinute
  • BytePerSecond
  • Cores
  • Count
  • Day
  • DecibelMilliWatt
  • GibiByte
  • GibiBytePerHour
  • GibiBytePerMinute
  • GibiBytePerSecond
  • Giga
  • GigaByte
  • GigaBytePerHour
  • GigaBytePerMinute
  • GigaBytePerSecond
  • Hour
  • KibiByte
  • KibiBytePerHour
  • KibiBytePerMinute
  • KibiBytePerSecond
  • Kilo
  • KiloByte
  • KiloBytePerHour
  • KiloBytePerMinute
  • KiloBytePerSecond
  • KiloMetrePerHour
  • MSU
  • MebiByte
  • MebiBytePerHour
  • MebiBytePerMinute
  • MebiBytePerSecond
  • Mega
  • MegaByte
  • MegaBytePerHour
  • MegaBytePerMinute
  • MegaBytePerSecond
  • MetrePerHour
  • MetrePerSecond
  • MicroSecond
  • MilliCores
  • MilliSecond
  • MilliSecondPerMinute
  • Million
  • Minute
  • Month
  • NanoSecond
  • NanoSecondPerMinute
  • NotApplicable
  • PerHour
  • PerMinute
  • PerSecond
  • Percent
  • Pixel
  • Promille
  • Ratio
  • Second
  • State
  • Trillion
  • Unspecified
  • Week
  • Year
rightAxisCustomUnitstring

The custom unit for the right Y-axis.

The element can hold these values
  • Billion
  • Bit
  • BitPerHour
  • BitPerMinute
  • BitPerSecond
  • Byte
  • BytePerHour
  • BytePerMinute
  • BytePerSecond
  • Cores
  • Count
  • Day
  • DecibelMilliWatt
  • GibiByte
  • GibiBytePerHour
  • GibiBytePerMinute
  • GibiBytePerSecond
  • Giga
  • GigaByte
  • GigaBytePerHour
  • GigaBytePerMinute
  • GigaBytePerSecond
  • Hour
  • KibiByte
  • KibiBytePerHour
  • KibiBytePerMinute
  • KibiBytePerSecond
  • Kilo
  • KiloByte
  • KiloBytePerHour
  • KiloBytePerMinute
  • KiloBytePerSecond
  • KiloMetrePerHour
  • MSU
  • MebiByte
  • MebiBytePerHour
  • MebiBytePerMinute
  • MebiBytePerSecond
  • Mega
  • MegaByte
  • MegaBytePerHour
  • MegaBytePerMinute
  • MegaBytePerSecond
  • MetrePerHour
  • MetrePerSecond
  • MicroSecond
  • MilliCores
  • MilliSecond
  • MilliSecondPerMinute
  • Million
  • Minute
  • Month
  • NanoSecond
  • NanoSecondPerMinute
  • NotApplicable
  • PerHour
  • PerMinute
  • PerSecond
  • Percent
  • Pixel
  • Promille
  • Ratio
  • Second
  • State
  • Trillion
  • Unspecified
  • Week
  • Year

The CustomFilterChartSeriesConfig object

Configuration of a charted metric.

ElementTypeDescription
metricstring

The name of the charted metric.

aggregationstring

The charted aggregation of the metric.

The element can hold these values
  • AVG
  • COUNT
  • DISTINCT
  • FASTEST10PERCENT
  • MAX
  • MEDIAN
  • MIN
  • NONE
  • OF_INTEREST_RATIO
  • OTHER_RATIO
  • PERCENTILE
  • PER_MIN
  • SLOWEST10PERCENT
  • SLOWEST5PERCENT
  • SUM
  • SUM_DIMENSIONS
percentileinteger

The charted percentile.

Only applicable if the aggregation is set to PERCENTILE.

typestring

The visualization of the timeseries chart.

The element can hold these values
  • AREA
  • BAR
  • LINE
entityTypestring

The type of the Dynatrace entity that delivered the charted metric.

dimensionsCustomFilterChartSeriesDimensionConfig[]

Configuration of the charted metric splitting.

sortAscendingboolean

Sort ascending (true) or descending (false).

sortColumnboolean-
aggregationRatestring-
The element can hold these values
  • HOUR
  • MINUTE
  • SECOND
  • TOTAL

The CustomFilterChartSeriesDimensionConfig object

Configuration of the charted metric splitting.

ElementTypeDescription
idstring

The ID of the dimension by which the metric is split.

namestring

The name of the dimension by which the metric is split.

valuesstring[]

The splitting value.

entityDimensionboolean-

The CustomChartingItemMetadataConfig object

Additional metadata for charted metric.

ElementTypeDescription
lastModifiedinteger

The timestamp of the last metadata modification, in UTC milliseconds.

customColorstring

The color of the metric in the chart, hex format.

json
{ "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)
MarkdownTile

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.

ElementTypeDescription
markdownstring

The markdown-formatted content of the tile.

json
{ "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)" }

ProblemTile

This type applies to the following tiles:

  • Problems (OPEN_PROBLEMS)
ProblemTile

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.

ElementTypeDescription
problemSelectorstring

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.

entitySelectorstring

The entity scope of the problem tile. For further information please look at the Problems API v2 '/problems' endpoint.

json
{ "name": "Host health", "tileType": "OPEN_PROBLEMS", "configured": true, "bounds": { "top": 47, "left": 415, "width": 304, "height": 304 }, "tileFilter": { "timeframe": "-3h to now", "managementZone": { "id": "9130632296508575249", "name": "Easytravel" } }, "problemSelector": "status(\"open\")", "entitySelector": "type(\"HOST\"),tag(\"easyTravel\")" }

ScalableListTile

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.

ElementTypeDescription
customFilterIdstring

The ID of the custom filter.

entitySpecificTileTypestring

The type of the entity specific tile.

The element can hold these values
  • APPLICATION
  • APPLICATIONS
  • APPLICATIONS_MOST_ACTIVE
  • APPLICATION_WORLDMAP
  • AWS
  • BOUNCE_RATE
  • CUSTOM_APPLICATION
  • CUSTOM_CHARTING
  • DATABASE
  • DATABASES_OVERVIEW
  • DATA_EXPLORER
  • DCRUM_SERVICES
  • DEM_KEY_USER_ACTION
  • DOCKER
  • DTAQL
  • HEADER
  • HOST
  • HOSTS
  • IMAGE
  • LOGS_EVENTS_QUERY
  • LOG_ANALYTICS
  • LOG_QUERY
  • MARKDOWN
  • MOBILE_APPLICATION
  • NETWORK
  • NETWORK_MEDIUM
  • OPEN_PROBLEMS
  • PROCESS_GROUPS_ONE
  • PURE_MODEL
  • RESOURCES
  • SCALABLE_LIST
  • SERVICES
  • SERVICE_VERSATILE
  • SESSION_METRICS
  • SLO
  • SYNTHETIC_HTTP_MONITOR
  • SYNTHETIC_SINGLE_EXT_TEST
  • SYNTHETIC_SINGLE_WEBCHECK
  • SYNTHETIC_TESTS
  • THIRD_PARTY_MOST_ACTIVE
  • UEM_ACTIVE_SESSIONS
  • UEM_CONVERSIONS_OVERALL
  • UEM_CONVERSIONS_PER_GOAL
  • UEM_JSERRORS_OVERALL
  • UEM_KEY_USER_ACTIONS
  • USERS
  • VIRTUALIZATION
chartVisibleboolean-
json
{ "name": "ScalableList", "nameSize": "", "tileType": "Image", "configured": true, "bounds": { "top": 112, "left": 45, "width": 304, "height": 304 }, "tileFilter": { "timeframe": null, "managementZone": null }, "entitySpecificTileType": "DATA_EXLORER" }

SyntheticSingleWebcheckTile

This type applies to the following tiles:

  • Browser monitor (SYNTHETIC_SINGLE_WEBCHECK)
SyntheticSingleWebcheckTile

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.

ElementTypeDescription
assignedEntitiesstring[]

The list of Dynatrace entities, assigned to the tile.

excludeMaintenanceWindowsboolean

Include (false') or exclude (true`) maintenance windows from availability calculations.

json
{ "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 }

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)
Tile

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.

ElementTypeDescription
namestring

The name of the tile.

nameSizestring

The size of the tile name. Default value is null.

The element can hold these values
  • small
  • medium
  • large
tileTypestring

Defines the actual set of fields depending on the value. See one of the following objects:

  • DATA_EXPLORER -> DataExplorerTile
  • CUSTOM_CHARTING -> CustomChartingTile
  • DTAQL -> UserSessionQueryTile
  • MARKDOWN -> MarkdownTile
  • IMAGE -> ImageTile
  • HOSTS -> FilterableEntityTile
  • APPLICATIONS -> FilterableEntityTile
  • SERVICES -> FilterableEntityTile
  • DATABASES_OVERVIEW -> FilterableEntityTile
  • SYNTHETIC_TESTS -> FilterableEntityTile
  • APPLICATION_WORLDMAP -> AssignedEntitiesWithMetricTile
  • RESOURCES -> AssignedEntitiesWithMetricTile
  • THIRD_PARTY_MOST_ACTIVE -> 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
  • DEVICE_APPLICATION_METHOD -> AssignedEntitiesTile
  • DEM_KEY_USER_ACTION -> AssignedEntitiesTile
  • SLO -> AssignedEntitiesWithMetricTile
  • SCALABLE_LIST -> ScalableListTile
  • HEADER -> Tile
  • OPEN_PROBLEMS -> ProblemTile
  • PURE_MODEL -> Tile
  • DOCKER -> Tile
  • NETWORK_MEDIUM -> Tile
  • APPLICATIONS_MOST_ACTIVE -> Tile
  • NETWORK -> Tile
  • UEM_ACTIVE_SESSIONS -> Tile
  • DCRUM_SERVICES -> Tile
The element can hold these values
  • APPLICATION
  • APPLICATIONS
  • APPLICATIONS_MOST_ACTIVE
  • APPLICATION_METHOD
  • APPLICATION_WORLDMAP
  • AWS
  • BOUNCE_RATE
  • CUSTOM_APPLICATION
  • CUSTOM_CHARTING
  • DATABASE
  • DATABASES_OVERVIEW
  • DATA_EXPLORER
  • DCRUM_SERVICES
  • DEM_KEY_USER_ACTION
  • DEVICE_APPLICATION_METHOD
  • DOCKER
  • DTAQL
  • HEADER
  • HOST
  • HOSTS
  • IMAGE
  • LOG_ANALYTICS
  • MARKDOWN
  • MOBILE_APPLICATION
  • NETWORK
  • NETWORK_MEDIUM
  • OPENSTACK
  • OPENSTACK_AV_ZONE
  • OPENSTACK_PROJECT
  • OPEN_PROBLEMS
  • PROCESS_GROUPS_ONE
  • PURE_MODEL
  • RESOURCES
  • SCALABLE_LIST
  • SERVICES
  • SERVICE_VERSATILE
  • SESSION_METRICS
  • SLO
  • SYNTHETIC_HTTP_MONITOR
  • SYNTHETIC_SINGLE_EXT_TEST
  • SYNTHETIC_SINGLE_WEBCHECK
  • SYNTHETIC_TESTS
  • THIRD_PARTY_MOST_ACTIVE
  • UEM_ACTIVE_SESSIONS
  • UEM_CONVERSIONS_OVERALL
  • UEM_CONVERSIONS_PER_GOAL
  • UEM_JSERRORS_OVERALL
  • UEM_KEY_USER_ACTIONS
  • USERS
  • VIRTUALIZATION
configuredboolean

The tile is configured and ready to use (true) or just placed on the dashboard (false).

boundsTileBounds

The position and size of a tile.

tileFilterTileFilter

A filter applied to a tile.

It overrides dashboard's filter.

isAutoRefreshDisabledboolean

The tile auto refresh is disabled. Only works for certain tile types.

The TileBounds object

The position and size of a tile.

ElementTypeDescription
topinteger

The vertical distance from the top left corner of the dashboard to the top left corner of the tile, in pixels.

leftinteger

The horizontal distance from the top left corner of the dashboard to the top left corner of the tile, in pixels.

widthinteger

The width of the tile, in pixels.

heightinteger

The height of the tile, in pixels.

The TileFilter object

A filter applied to a tile.

It overrides dashboard's filter.

ElementTypeDescription
timeframestring

The default timeframe of the tile.

managementZoneEntityShortRepresentation

The short representation of a Dynatrace entity.

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescription
idstring

The ID of the Dynatrace entity.

namestring

The name of the Dynatrace entity.

descriptionstring

A short description of the Dynatrace entity.

json
{ "name": "Tile", "nameSize": "", "tileType": "TILE", "configured": true, "bounds": { "top": 112, "left": 45, "width": 304, "height": 304 }, "tileFilter": { "timeframe": null, "managementZone": null } }

UserSessionQueryTile

This type applies to the following tiles:

  • User session query (DTAQL)
UserSessionQueryTile

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.

ElementTypeDescription
customNamestring

The name of the tile, set by user.

querystring

A user session query executed by the tile.

typestring

The visualization of the tile.

The element can hold these values
  • COLUMN_CHART
  • FUNNEL
  • LINE_CHART
  • NOT_CONFIGURED
  • PIE_CHART
  • SINGLE_VALUE
  • TABLE
timeFrameShiftstring

The comparison timeframe of the query.

If specified, you additionally get the results of the same query with the specified time shift.

visualizationConfigUserSessionQueryTileConfiguration

Configuration of a User session query visualization tile.

limitinteger

The limit of the results, if not set will use the default value of the system

The UserSessionQueryTileConfiguration object

Configuration of a User session query visualization tile.

ElementTypeDescription
hasAxisBucketingboolean

The axis bucketing when enabled groups similar series in the same virtual axis.

json
{ "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" }
Related topics
  • Dashboards

    Learn how to create, manage, and use Dynatrace dashboards.