• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Metric metadata

Settings API - Metric metadata schema table

Metric metadata (builtin:metric.metadata)

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

Schema IDSchema groupsScope
builtin:metric.metadata
  • group:metrics
metric
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:metric.metadata
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:metric.metadata
Environment ActiveGatehttps://{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

PropertyLabelTypeDescriptionRequired
displayNameDisplay nametext-optional
descriptionDescriptiontext-optional
unitUnittext-required
unitDisplayFormatUnit display formatenum

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.

optional
metricPropertiesMetric propertiesMetricProperties-optional
dimensionsMetric dimensionslist

Define metadata per metric dimension.

required
tagsTagslist-required
sourceEntityTypeSource entity typetext

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

Request body objects

The MetricProperties object
PropertyLabelTypeDescriptionRequired
minValueMinimum valuefloat

The minimum allowed value of the metric.

optional
maxValueMaximum valuefloat

The maximum allowed value of the metric.

optional
rootCauseRelevantRoot cause relevantboolean

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
impactRelevantImpact relevantboolean

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
valueTypeValue typeenum

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.

required
latencyLatencyinteger

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
PropertyLabelTypeDescriptionRequired
keyDimension keytext-required
displayNameDisplay nametext-optional