Settings API - Metric metadata schema table

Metric metadata (`builtin:metric.metadata)`

Custom metrics metadata allows you to provide additional information for your metric.

Schema ID	Schema groups	Scope
`builtin:metric.metadata`	`group:metrics`	`metric`

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

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	Type	Description	Required
Display name `displayName`	text	-	optional
Description `description`	text	-	optional
Unit `unit`	text	-	required
Unit display format `unitDisplayFormat`	enum	The raw value is stored in bits or bytes. The user interface can display it in these numeral systems: Binary: 1 MiB = 1024 KiB = 1,048,576 bytes Decimal: 1 MB = 1000 kB = 1,000,000 bytes If not set, the decimal system is used. `binary` `decimal`	optional
Metric properties `metricProperties`	MetricProperties	-	optional
Metric dimensions `dimensions`	Dimension[]	Define metadata per metric dimension.	required
Tags `tags`	list	-	required
Source entity type `sourceEntityType`	text	Specifies which entity dimension should be used as the primary dimension. The property can only be configured for metrics ingested with the Metrics API.	optional

The `MetricProperties` object

Property	Type	Description	Required
Minimum value `minValue`	float	The minimum allowed value of the metric.	optional
Maximum value `maxValue`	float	The maximum allowed value of the metric.	optional
Root cause relevant `rootCauseRelevant`	boolean	Whether (true or false) the metric is related to a root cause of a problem. A root-cause relevant metric represents a strong indicator for a faulty component.	optional
Impact relevant `impactRelevant`	boolean	Whether (true or false) the metric is relevant to a problem's impact. An impact-relevant metric is highly dependent on other metrics and changes because an underlying root-cause metric has changed.	optional
Value type `valueType`	enum	The type of the metric's value. You have these options: score: A score metric is a metric where high values indicate a good situation, while low values indicate trouble. An example of such a metric is a success rate. error: An error metric is a metric where high values indicate trouble, while low values indicate a good situation. An example of such a metric is an error count. `error` `score` `unknown`	required
Latency `latency`	integer	The latency of the metric, in minutes. The latency is the expected reporting delay (for example, caused by constraints of cloud vendors or other third-party data sources) between the observation of a metric data point and its availability in Dynatrace. The allowed value range is from 1 to 60 minutes.	optional

The `Dimension` object

Property	Type	Description	Required
Dimension key `key`	text	-	required
Display name `displayName`	text	-	optional