Settings API - Chart group cards schema table

Chart group cards (`builtin:ua.chart-groups`)

You can define here multiple chart groups with a unique key. These defined chart groups can then be referenced in the screen layout config. In the base config you can specify the order and if a group is shown on the screen.

Schema ID	Schema groups	Scope
`builtin:ua.chart-groups`	`group:unified-analysis`	`ua-screen`

Retrieve schema via Settings API

GET	Managed	`https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:ua.chart-groups`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:ua.chart-groups`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:ua.chart-groups`

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Property	Label	Type	Description	Required
key	Key	text	Unique key, which is used to map to this chart group in the screen layout config	required
mode	Mode	enum	-	required
displayName	Display name	text	The title of the card.	optional
description	Description	text	The description of the card Markdown syntax can be used to enrich description. To define a link, you can only use seaOtter links (https://dt-url.net/XXXXXXX) or action expression The format of a single action expression is: actionName\|key=param\|key2=param2	optional
entitySelectorTemplate	Entity selector template	text	An entity selector that is used to fetch data for related entities For example for a host screen where you want to show the processes charts this might look like this: `type(PROCESS_GROUP_INSTANCE), fromRelationships.isProcessOf($(entityConditions))` Please mind that the `$(entityConditions)` is a placeholder for the relation condition. Leave empty to gather data for current entity.	optional
numberOfVisibleCharts	Number of charts to display	integer	-	required
hideEmptyCharts	Hide empty charts	boolean	If true, All empty charts will be hidden. Decreases "Number of charts to display" to the number of available charts.	optional
charts	Charts	list	Collection of charts definition in this chart group	required
appendDetectedMetrics	Append Detected Metrics	boolean	If true, Charts for all associated metrics will be generated and appended to the list in chart selector.	optional
chartsInRow	Maximum number of charts in a row	integer	-	optional
conditions	List of conditions	set	All conditions from the list need to be fulfilled for the ChartGroup card to be visible	required

Request body objects

The `Threshold` object

Property	Label	Type	Description	Required
color	Color	text	RGB code of color	required
value	Threshold value	float	Value of the threshold. Area above this threshold will be marked by selected color	required

The `MetricSelector` object

Property	Label	Type	Description	Required
metricSelector	Metric selector expression	text	-	required

The `SingleValueConfig` object

Property	Label	Type	Description	Required
metric	Metric	MetricSelector	Defines how to fetch data for the single value visualization, please note that it shows only the first enabled metric from the query and also various fold transformations needs to be explicitly defined here in the selector	required
defaultAggregation	Default aggregation	enum	Defines default aggregation of the chart timeseries. If not defined or selected one is not supported, it is deduced from metrics metadata.	optional
thresholds	List thresholds	set	List of defined thresholds for the chart	required
showTrend	Show trend	boolean	When true, the trend is visible	optional
showSparkline	Show sparkline	boolean	When true, the sparkline is visible	optional
displayName	Display name	text	Display name for value	optional
foldTransformation	Fold transformation	enum	Defines transformation method, which fold data into single value. If not defined, it is deduced automatically.	optional

The `ColorOverrides` object

Property	Label	Type	Description	Required
color	Color	text	RGB code of color	required
seriesName	Series Name	text	Series name should point to whole metric or single dimension name	required

The `PieChartConfig` object

Property	Label	Type	Description	Required
metric	Metric	MetricSelector	Defines how to fetch data for the pie chart, please note that various fold transformations needs to be explicitly defined here in the selector	required
defaultAggregation	Default aggregation	enum	Defines default aggregation of the chart timeseries. If not defined or selected one is not supported, it is deduced from metrics metadata.	optional
themeColor	Color theme	enum	-	optional
colorOverride	List of color overrides	set	There is possibility to override color of single series, even single dimension of a metric	required
showLegend	Show legend	boolean	When true, axis legend on the whole chart is visible	optional

The `XAxis` object

Property	Label	Type	Description	Required
name	Name	text	-	optional
visible	Is visible	boolean	When true, axis legend is visible	required

The `YAxis` object

Property	Label	Type	Description	Required
key	Y-Axis key	text	Y-axis key to be matched with metric's reference	required
name	Axis title	text	Axis title	optional
position	Position	enum	Pick a side for the axis	required
visible	Is visible	boolean	When true, axis is visible	required
min	Min	text	Minimal axis value	optional
max	Max	text	Maximal axis value	optional

The `VisualizationOptions` object

Property	Label	Type	Description	Required
themeColor	Color theme	enum	-	optional
seriesType	Series type	enum	-	optional
showLegend	Show legend	boolean	When true, axis legend on the whole chart is visible	optional

The `MetricVisualizationOptions` object

Property	Label	Type	Description	Required
themeColor	Color theme	enum	-	optional
seriesType	Series type	enum	-	optional
displayName	Display name	text	-	optional
colorOverride	List of color overrides	set	There is possibility to override color of single series, even single dimension of a metric	required

The `MetricDefinition` object

Property Label Type Description Required

metricSelector

Metric selector expression

Property	Label	Type	Description	Required
metricSelector	Metric selector expression	text	A metric selector expression for a dedicated metric line For example, if you want to show the available disk space of a host, use `builtin:host.disk.free`. It also supports the ability to split by dimension, aggregate the selected metric and a lot more, for example: `builtin:host.disk.free:splitBy(dt.entity.disk):max` The filter for the ME id will be applied automatically. The Metric Browser gives an overview of all the metrics an the available operations for every metric.	required
visualization	Visualization	MetricVisualizationOptions	-	optional
yAxisKey	Y-Axis key	text	Select Y-axis to be matched with this metric by its key	optional

text

A metric selector expression for a dedicated metric line

For example, if you want to show the available disk space of a host, use
builtin:host.disk.free.

It also supports the ability to split by dimension, aggregate the selected metric and a lot more, for example:
builtin:host.disk.free:splitBy(dt.entity.disk):max
The filter for the ME id will be applied automatically.

The Metric Browser gives an overview of all the metrics an the available operations for every metric.

required

visualization Visualization MetricVisualizationOptions - optional

yAxisKey

Y-Axis key

text

Select Y-axis to be matched with this metric by its key

optional

The `GraphChartConfig` object

Property	Label	Type	Description	Required
metrics	Metrics	list	Defines how to fetch data for a single line in the chart	required
defaultAggregation	Default aggregation	enum	Defines default aggregation of the chart timeseries. If not defined or selected one is not supported, it is deduced from metrics metadata.	optional
visualization	Visualization	VisualizationOptions	-	optional
thresholds	List thresholds	set	List of defined thresholds for the chart	required
yAxes	Y axes	list	You can control how each Y axis of your graph are displayed	required
xAxis	X axis	XAxis	You can control how X axis of your graph are displayed	optional
stacked	Stacked chart	boolean	When true, series on chart are stacked.	optional
connectGaps	Connect gaps	boolean	When true, gaps in charts will be connected even if there is truly no data	optional

The `ChartDefinition` object

Property	Label	Type	Description	Required
displayName	Display name	text	-	required
detailsMessage	Details message	text	The message displayed when chart-group choice of charts and aggregation is fixed	optional
conditions	List of conditions	set	All conditions from the list need to be fulfilled for the chart to be visible	required
visualizationType	Visualization Type	enum	-	required
graphChartConfig	-	GraphChartConfig	-	required
pieChartConfig	-	PieChartConfig	-	required
singleValueConfig	-	SingleValueConfig	-	required

Settings API - Chart group cards schema table

Chart group cards (builtin:ua.chart-groups)

Authentication

Parameters

Request body objects

The Threshold object

The MetricSelector object

The SingleValueConfig object

The ColorOverrides object

The PieChartConfig object

The XAxis object

The YAxis object

The VisualizationOptions object

The MetricVisualizationOptions object

The MetricDefinition object

The GraphChartConfig object

The ChartDefinition object