Settings API - Metric events schema table

Metric events (`builtin:anomaly-detection.metric-events)`

Metric event configurations are used to automatically detect anomalies in metric timeseries by using thresholds or baselines.

Schema ID	Schema groups	Scope
`builtin:anomaly-detection.metric-events`	`group:anomaly-detection`	`environment`

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

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
Enabled `enabled`	boolean	-	required
Summary `summary`	text	The textual summary of the metric event entry	required
Query definition `queryDefinition`	QueryDefinition	-	required
Monitoring strategy `modelProperties`	ModelProperties	-	required
Event template `eventTemplate`	EventTemplate	-	required
Dimension key of entity for events `eventEntityDimensionKey`	text	Controls the preferred entity type used for triggered events.	optional
Config id `legacyId`	text	-	optional

The `QueryDefinition` object

Property	Type	Description	Required
Type `type`	enum	`METRIC_KEY` `METRIC_SELECTOR`	required
Metric selector `metricSelector`	text	To learn more, visit Metric Selector	required
Metric key `metricKey`	text	-	required
Aggregation `aggregation`	enum	`MIN` `MAX` `SUM` `COUNT` `AVG` `VALUE` `MEDIAN` `PERCENTILE90`	required
Management zone `managementZone`	text	-	optional
Query offset `queryOffset`	integer	Minute offset of sliding evaluation window for metrics with latency	optional
Entities `entityFilter`	EntityFilter	Use rule-based filters to define the scope this event monitors.	required
Dimension filter `dimensionFilter`	DimensionFilter[]	-	required

The `ModelProperties` object

Property	Type	Description	Required
Model type `type`	enum	Metric-key-based query definitions only support static thresholds. `STATIC_THRESHOLD` `AUTO_ADAPTIVE_THRESHOLD` `SEASONAL_BASELINE`	required
Threshold `threshold`	float	Raise an event if this value is violated	required
Alert on missing data `alertOnNoData`	boolean	The ability to set an alert on missing data in a metric. When enabled, missing data samples will contribute as violating samples defined in advanced model properties. We recommend to not alert on missing data for sparse timeseries as this leads to alert spam.	required
Number of signal fluctuations `signalFluctuation`	float	Controls how many times the signal fluctuation is added to the baseline to produce the actual threshold for alerting	required
Tolerance `tolerance`	float	Controls the width of the confidence band and larger values lead to a less sensitive model	required
Alert condition `alertCondition`	enum	`ABOVE` `BELOW` `OUTSIDE`	required
Violating samples `violatingSamples`	integer	The number of one-minute samples within the evaluation window that must violate to trigger an event.	required
Sliding window `samples`	integer	The number of one-minute samples that form the sliding evaluation window.	required
Dealerting samples `dealertingSamples`	integer	The number of one-minute samples within the evaluation window that must go back to normal to close the event.	required

The `EventTemplate` object

Property	Type	Description	Required
Title `title`	text	The title of the event to trigger. Type '{' for placeholder hints.	required
Description `description`	text	The description of the event to trigger. Type '{' for placeholder hints.	required
Event type `eventType`	enum	The event type to trigger. `INFO` `ERROR` `AVAILABILITY` `SLOWDOWN` `RESOURCE` `CUSTOM_ALERT` `CUSTOM_ANNOTATION` `CUSTOM_CONFIGURATION` `CUSTOM_DEPLOYMENT` `MARKED_FOR_TERMINATION`	required
Allow merge `davisMerge`	boolean	Davis® AI will try to merge this event into existing problems, otherwise a new problem will always be created.	required
Properties `metadata`	Set<MetadataItem>	Set of additional key-value properties to be attached to the triggered event.	required

The `EntityFilter` object

Property	Type	Description	Required
Dimension key of entity type `dimensionKey`	text	Dimension key of entity type to filter	optional
`conditions`	EntityFilterCondition[]	-	required

The `DimensionFilter` object

Property	Type	Description	Required
Dimension key `dimensionKey`	text	-	required
Operator `operator`	enum	`EQUALS` `DOES_NOT_EQUAL` `STARTS_WITH` `DOES_NOT_START_WITH` `CONTAINS_CASE_SENSITIVE` `DOES_NOT_CONTAIN_CASE_SENSITIVE`	optional
Dimension value `dimensionValue`	text	-	required

The `MetadataItem` object

Property	Type	Description	Required
Key `metadataKey`	text	Type 'dt.' for key hints.	required
Value `metadataValue`	text	Type '{' for placeholder hints.	required

The `EntityFilterCondition` object

Property	Type	Description	Required
Filter type `type`	enum	`NAME` `ENTITY_ID` `MANAGEMENT_ZONE` `TAG` `HOST_NAME` `HOST_GROUP_NAME` `PROCESS_GROUP_NAME` `PROCESS_GROUP_ID` `CUSTOM_DEVICE_GROUP_NAME`	required
Operator `operator`	enum	`EQUALS` `DOES_NOT_EQUAL` `STARTS_WITH` `DOES_NOT_START_WITH` `CONTAINS_CASE_SENSITIVE` `DOES_NOT_CONTAIN_CASE_SENSITIVE` `CONTAINS_CASE_INSENSITIVE` `DOES_NOT_CONTAIN_CASE_INSENSITIVE`	required
Value `value`	text	-	required

Settings API - Metric events schema table

Metric events (builtin:anomaly-detection.metric-events)

Authentication

Parameters

The QueryDefinition object

The ModelProperties object

The EventTemplate object

The EntityFilter object

The DimensionFilter object

The MetadataItem object

The EntityFilterCondition object