• Home
  • Dynatrace API
  • Configuration
  • Anomaly detection
  • Metric event
  • JSON models

Metric events anomaly detection API - JSON models

Some JSON models of the Metric events anomaly detection API vary, depending on the filterType of some objects. Here you can find JSON models for each variation.

Variations of the MetricEventAlertingScope object

The MetricEventAlertingScope object is the base for alerting scopes of metric events. The actual set of fields depends on the filterType of the scope.

CUSTOM_DEVICE_GROUP_NAME

CustomDeviceGroupNameAlertingScope

The CustomDeviceGroupNameAlertingScope object

ElementTypeDescription
nameFilterMetricEventTextFilterMetricEventTextFilterOperatorDto

A filter for a string value based on the given operator.

Can be null.

The MetricEventAlertingScope object

A single filter for the alerting scope.

The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.

ElementTypeDescription
filterTypestring

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

  • ENTITY_ID -> EntityIdAlertingScope
  • MANAGEMENT_ZONE -> ManagementZoneAlertingScope
  • TAG -> TagFilterAlertingScope
  • NAME -> NameAlertingScope
  • CUSTOM_DEVICE_GROUP_NAME -> CustomDeviceGroupNameAlertingScope
  • HOST_GROUP_NAME -> HostGroupNameAlertingScope
  • HOST_NAME -> HostNameAlertingScope
  • PROCESS_GROUP_ID -> ProcessGroupIdAlertingScope
  • PROCESS_GROUP_NAME -> ProcessGroupNameAlertingScope
The element can hold these values
  • CUSTOM_DEVICE_GROUP_NAME
  • ENTITY_ID
  • HOST_GROUP_NAME
  • HOST_NAME
  • MANAGEMENT_ZONE
  • NAME
  • PROCESS_GROUP_ID
  • PROCESS_GROUP_NAME
  • TAG
json
{ "filterType": "CUSTOM_DEVICE_GROUP_NAME", "nameFilter": { "value": "entity name", "operator": "CONTAINS_CASE_INSENSITIVE" } }

ENTITY_ID

EntityIdAlertingScope

The EntityIdAlertingScope object

ElementTypeDescription
entityIdstring

The monitored entities id to match on.

Can be null.

The MetricEventAlertingScope object

A single filter for the alerting scope.

The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.

ElementTypeDescription
filterTypestring

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

  • ENTITY_ID -> EntityIdAlertingScope
  • MANAGEMENT_ZONE -> ManagementZoneAlertingScope
  • TAG -> TagFilterAlertingScope
  • NAME -> NameAlertingScope
  • CUSTOM_DEVICE_GROUP_NAME -> CustomDeviceGroupNameAlertingScope
  • HOST_GROUP_NAME -> HostGroupNameAlertingScope
  • HOST_NAME -> HostNameAlertingScope
  • PROCESS_GROUP_ID -> ProcessGroupIdAlertingScope
  • PROCESS_GROUP_NAME -> ProcessGroupNameAlertingScope
The element can hold these values
  • CUSTOM_DEVICE_GROUP_NAME
  • ENTITY_ID
  • HOST_GROUP_NAME
  • HOST_NAME
  • MANAGEMENT_ZONE
  • NAME
  • PROCESS_GROUP_ID
  • PROCESS_GROUP_NAME
  • TAG
json
{ "filterType": "ENTITY_ID", "entityId": "HOST-B7A6F9EE9F366CB5" }

HOST_NAME

HostNameAlertingScope

The HostNameAlertingScope object

ElementTypeDescription
nameFilterMetricEventTextFilterMetricEventTextFilterOperatorDto

A filter for a string value based on the given operator.

Can be null.

The MetricEventAlertingScope object

A single filter for the alerting scope.

The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.

ElementTypeDescription
filterTypestring

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

  • ENTITY_ID -> EntityIdAlertingScope
  • MANAGEMENT_ZONE -> ManagementZoneAlertingScope
  • TAG -> TagFilterAlertingScope
  • NAME -> NameAlertingScope
  • CUSTOM_DEVICE_GROUP_NAME -> CustomDeviceGroupNameAlertingScope
  • HOST_GROUP_NAME -> HostGroupNameAlertingScope
  • HOST_NAME -> HostNameAlertingScope
  • PROCESS_GROUP_ID -> ProcessGroupIdAlertingScope
  • PROCESS_GROUP_NAME -> ProcessGroupNameAlertingScope
The element can hold these values
  • CUSTOM_DEVICE_GROUP_NAME
  • ENTITY_ID
  • HOST_GROUP_NAME
  • HOST_NAME
  • MANAGEMENT_ZONE
  • NAME
  • PROCESS_GROUP_ID
  • PROCESS_GROUP_NAME
  • TAG
json
{ "filterType": "HOST_NAME", "nameFilter": { "value": "entity name", "operator": "CONTAINS_CASE_INSENSITIVE" } }

HOST_GROUP_NAME

HostGroupNameAlertingScope

The HostGroupNameAlertingScope object

ElementTypeDescription
nameFilterMetricEventTextFilterMetricEventTextFilterOperatorDto

A filter for a string value based on the given operator.

Can be null.

The MetricEventAlertingScope object

A single filter for the alerting scope.

The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.

ElementTypeDescription
filterTypestring

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

  • ENTITY_ID -> EntityIdAlertingScope
  • MANAGEMENT_ZONE -> ManagementZoneAlertingScope
  • TAG -> TagFilterAlertingScope
  • NAME -> NameAlertingScope
  • CUSTOM_DEVICE_GROUP_NAME -> CustomDeviceGroupNameAlertingScope
  • HOST_GROUP_NAME -> HostGroupNameAlertingScope
  • HOST_NAME -> HostNameAlertingScope
  • PROCESS_GROUP_ID -> ProcessGroupIdAlertingScope
  • PROCESS_GROUP_NAME -> ProcessGroupNameAlertingScope
The element can hold these values
  • CUSTOM_DEVICE_GROUP_NAME
  • ENTITY_ID
  • HOST_GROUP_NAME
  • HOST_NAME
  • MANAGEMENT_ZONE
  • NAME
  • PROCESS_GROUP_ID
  • PROCESS_GROUP_NAME
  • TAG
json
{ "filterType": "HOST_GROUP_NAME", "nameFilter": { "value": "entity name", "operator": "CONTAINS_CASE_INSENSITIVE" } }

MANAGEMENT_ZONE

ManagementZoneAlertingScope

The ManagementZoneAlertingScope object

ElementTypeDescription
mzIdstring

The management zone id to match on.

Can be null.

The MetricEventAlertingScope object

A single filter for the alerting scope.

The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.

ElementTypeDescription
filterTypestring

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

  • ENTITY_ID -> EntityIdAlertingScope
  • MANAGEMENT_ZONE -> ManagementZoneAlertingScope
  • TAG -> TagFilterAlertingScope
  • NAME -> NameAlertingScope
  • CUSTOM_DEVICE_GROUP_NAME -> CustomDeviceGroupNameAlertingScope
  • HOST_GROUP_NAME -> HostGroupNameAlertingScope
  • HOST_NAME -> HostNameAlertingScope
  • PROCESS_GROUP_ID -> ProcessGroupIdAlertingScope
  • PROCESS_GROUP_NAME -> ProcessGroupNameAlertingScope
The element can hold these values
  • CUSTOM_DEVICE_GROUP_NAME
  • ENTITY_ID
  • HOST_GROUP_NAME
  • HOST_NAME
  • MANAGEMENT_ZONE
  • NAME
  • PROCESS_GROUP_ID
  • PROCESS_GROUP_NAME
  • TAG
json
{ "filterType": "MANAGEMENT_ZONE", "mzId": "6958644387494623526" }

NAME

NameAlertingScope

The NameAlertingScope object

ElementTypeDescription
nameFilterMetricEventTextFilterMetricEventTextFilterOperatorDto

A filter for a string value based on the given operator.

Can be null.

The MetricEventAlertingScope object

A single filter for the alerting scope.

The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.

ElementTypeDescription
filterTypestring

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

  • ENTITY_ID -> EntityIdAlertingScope
  • MANAGEMENT_ZONE -> ManagementZoneAlertingScope
  • TAG -> TagFilterAlertingScope
  • NAME -> NameAlertingScope
  • CUSTOM_DEVICE_GROUP_NAME -> CustomDeviceGroupNameAlertingScope
  • HOST_GROUP_NAME -> HostGroupNameAlertingScope
  • HOST_NAME -> HostNameAlertingScope
  • PROCESS_GROUP_ID -> ProcessGroupIdAlertingScope
  • PROCESS_GROUP_NAME -> ProcessGroupNameAlertingScope
The element can hold these values
  • CUSTOM_DEVICE_GROUP_NAME
  • ENTITY_ID
  • HOST_GROUP_NAME
  • HOST_NAME
  • MANAGEMENT_ZONE
  • NAME
  • PROCESS_GROUP_ID
  • PROCESS_GROUP_NAME
  • TAG
json
{ "filterType": "NAME", "nameFilter": { "value": "entity name", "operator": "CONTAINS_CASE_INSENSITIVE" } }

PROCESS_GROUP_ID

ProcessGroupIdAlertingScope

The ProcessGroupIdAlertingScope object

ElementTypeDescription
processGroupIdstring

The process groups id to match on.

Can be null.

The MetricEventAlertingScope object

A single filter for the alerting scope.

The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.

ElementTypeDescription
filterTypestring

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

  • ENTITY_ID -> EntityIdAlertingScope
  • MANAGEMENT_ZONE -> ManagementZoneAlertingScope
  • TAG -> TagFilterAlertingScope
  • NAME -> NameAlertingScope
  • CUSTOM_DEVICE_GROUP_NAME -> CustomDeviceGroupNameAlertingScope
  • HOST_GROUP_NAME -> HostGroupNameAlertingScope
  • HOST_NAME -> HostNameAlertingScope
  • PROCESS_GROUP_ID -> ProcessGroupIdAlertingScope
  • PROCESS_GROUP_NAME -> ProcessGroupNameAlertingScope
The element can hold these values
  • CUSTOM_DEVICE_GROUP_NAME
  • ENTITY_ID
  • HOST_GROUP_NAME
  • HOST_NAME
  • MANAGEMENT_ZONE
  • NAME
  • PROCESS_GROUP_ID
  • PROCESS_GROUP_NAME
  • TAG
json
{ "filterType": "PROCESS_GROUP_ID", "processGroupId": "PROCESS_GROUP-B34081EFF9E5F516" }

PROCESS_GROUP_NAME

ProcessGroupNameAlertingScope

The ProcessGroupNameAlertingScope object

ElementTypeDescription
nameFilterMetricEventTextFilterMetricEventTextFilterOperatorDto

A filter for a string value based on the given operator.

Can be null.

The MetricEventAlertingScope object

A single filter for the alerting scope.

The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.

ElementTypeDescription
filterTypestring

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

  • ENTITY_ID -> EntityIdAlertingScope
  • MANAGEMENT_ZONE -> ManagementZoneAlertingScope
  • TAG -> TagFilterAlertingScope
  • NAME -> NameAlertingScope
  • CUSTOM_DEVICE_GROUP_NAME -> CustomDeviceGroupNameAlertingScope
  • HOST_GROUP_NAME -> HostGroupNameAlertingScope
  • HOST_NAME -> HostNameAlertingScope
  • PROCESS_GROUP_ID -> ProcessGroupIdAlertingScope
  • PROCESS_GROUP_NAME -> ProcessGroupNameAlertingScope
The element can hold these values
  • CUSTOM_DEVICE_GROUP_NAME
  • ENTITY_ID
  • HOST_GROUP_NAME
  • HOST_NAME
  • MANAGEMENT_ZONE
  • NAME
  • PROCESS_GROUP_ID
  • PROCESS_GROUP_NAME
  • TAG
json
{ "filterType": "PROCESS_GROUP_NAME", "nameFilter": { "value": "entity name", "operator": "CONTAINS_CASE_INSENSITIVE" } }

TAG

TagFilterAlertingScope

The TagFilterAlertingScope object

ElementTypeDescription
tagFilterTagFilter

A tag-based filter of monitored entities.

Can be null.

The MetricEventAlertingScope object

A single filter for the alerting scope.

The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.

ElementTypeDescription
filterTypestring

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

  • ENTITY_ID -> EntityIdAlertingScope
  • MANAGEMENT_ZONE -> ManagementZoneAlertingScope
  • TAG -> TagFilterAlertingScope
  • NAME -> NameAlertingScope
  • CUSTOM_DEVICE_GROUP_NAME -> CustomDeviceGroupNameAlertingScope
  • HOST_GROUP_NAME -> HostGroupNameAlertingScope
  • HOST_NAME -> HostNameAlertingScope
  • PROCESS_GROUP_ID -> ProcessGroupIdAlertingScope
  • PROCESS_GROUP_NAME -> ProcessGroupNameAlertingScope
The element can hold these values
  • CUSTOM_DEVICE_GROUP_NAME
  • ENTITY_ID
  • HOST_GROUP_NAME
  • HOST_NAME
  • MANAGEMENT_ZONE
  • NAME
  • PROCESS_GROUP_ID
  • PROCESS_GROUP_NAME
  • TAG
json
{ "filterType": "TAG", "tagFilter": { "context": "CONTEXTLESS", "key": "Infrastructure", "value": "Linux" } }

Variations of the MetricEventDimensions object

The MetricEventDimensions object is the base for metric dimensions. The actual set of fields depends on the filterType of the dimension.

ENTITY

MetricEventEntityDimensions

The MetricEventEntityDimensions object

ElementTypeDescription
nameFilterMetricEventTextFilterMetricEventDimensionsFilterOperatorDto

A filter for a string value based on the given operator.

Can be null.

The MetricEventDimensions object

A single filter for the metrics dimensions.

The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.

ElementTypeDescription
filterTypestring

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

  • ENTITY -> MetricEventEntityDimensions
  • STRING -> MetricEventStringDimensions
The element can hold these values
  • ENTITY
  • STRING
keystring

The dimensions key on the metric.

Can be null.

json
{ "filterType": "ENTITY", "name": "dimension", "index": 1, "nameFilter": { "value": "entity name", "operator": "EQUALS" } }

STRING

MetricEventStringDimensions

The MetricEventStringDimensions object

ElementTypeDescription
textFilterMetricEventTextFilterMetricEventDimensionsFilterOperatorDto

A filter for a string value based on the given operator.

Can be null.

The MetricEventDimensions object

A single filter for the metrics dimensions.

The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.

ElementTypeDescription
filterTypestring

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

  • ENTITY -> MetricEventEntityDimensions
  • STRING -> MetricEventStringDimensions
The element can hold these values
  • ENTITY
  • STRING
keystring

The dimensions key on the metric.

Can be null.

json
{ "filterType": "STRING", "name": "dimension", "index": 1, "nameFilter": { "value": "entity name", "operator": "EQUALS" } }

Variations of the MetricEventMonitoringStrategy object

The MetricEventMonitoringStrategy object is the base for monitoring strategy of a metric event. The actual set of fields depends on the type of the strategy.

AUTO_ADAPTIVE_BASELINE

MetricEventAutoAdaptiveBaselineMonitoringStrategy

The MetricEventAutoAdaptiveBaselineMonitoringStrategy object

ElementTypeDescription
samplesinteger

The number of one-minute samples that form the sliding evaluation window.

Can be null.

violatingSamplesinteger

The number of one-minute samples within the evaluation window that must violate the threshold to trigger an event.

Can be null.

dealertingSamplesinteger

The number of one-minute samples within the evaluation window that must go back to normal to close the event.

Can be null.

alertConditionstring

The condition for the threshold value check: above or below.

The element can hold these values
  • ABOVE
  • BELOW

Can be null.

alertingOnMissingDataboolean

If true, also one-minute samples without data are counted as violating samples.

Can be null.

numberOfSignalFluctuationsnumber

Defines the factor of how many signal fluctuations are valid. Values above the baseline plus the signal fluctuation times the number of tolerated signal fluctuations are alerted.

Can be null.

The MetricEventMonitoringStrategy object

A monitoring strategy for a metric event config.

This is the base version of the monitoring strategy, depending on the type, the actual JSON may contain additional fields.

ElementTypeDescription
typestring

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

  • STATIC_THRESHOLD -> MetricEventStaticThresholdMonitoringStrategy
  • AUTO_ADAPTIVE_BASELINE -> MetricEventAutoAdaptiveBaselineMonitoringStrategy
The element can hold these values
  • AUTO_ADAPTIVE_BASELINE
  • STATIC_THRESHOLD
json
{ "type": "AUTO_ADAPTIVE_BASELINE", "samples": 5, "violatingSamples": 3, "dealertingSamples": 5, "alertCondition": "ABOVE", "alertingOnMissingData": false, "numberOfSignalFluctuations": 1.0 }

STATIC_THRESHOLD

MetricEventStaticThresholdMonitoringStrategy

The MetricEventStaticThresholdMonitoringStrategy object

ElementTypeDescription
samplesinteger

The number of one-minute samples that form the sliding evaluation window.

Can be null.

violatingSamplesinteger

The number of one-minute samples within the evaluation window that must violate the threshold to trigger an event.

Can be null.

dealertingSamplesinteger

The number of one-minute samples within the evaluation window that must go back to normal to close the event.

Can be null.

alertConditionstring

The condition for the threshold value check: above or below.

The element can hold these values
  • ABOVE
  • BELOW

Can be null.

alertingOnMissingDataboolean

If true, also one-minute samples without data are counted as violating samples.

Can be null.

thresholdnumber

The value of the static threshold based on the specified unit.

Can be null.

unitstring

The unit of the threshold, matching the metric definition.

The element can hold these values
  • BIT
  • BIT_PER_HOUR
  • BIT_PER_MINUTE
  • BIT_PER_SECOND
  • BYTE
  • BYTE_PER_HOUR
  • BYTE_PER_MINUTE
  • BYTE_PER_SECOND
  • CORES
  • COUNT
  • DAY
  • DECIBEL_MILLI_WATT
  • GIBI_BYTE
  • GIGA
  • GIGA_BYTE
  • HOUR
  • KIBI_BYTE
  • KIBI_BYTE_PER_HOUR
  • KIBI_BYTE_PER_MINUTE
  • KIBI_BYTE_PER_SECOND
  • KILO
  • KILO_BYTE
  • KILO_BYTE_PER_HOUR
  • KILO_BYTE_PER_MINUTE
  • KILO_BYTE_PER_SECOND
  • MEBI_BYTE
  • MEBI_BYTE_PER_HOUR
  • MEBI_BYTE_PER_MINUTE
  • MEBI_BYTE_PER_SECOND
  • MEGA
  • MEGA_BYTE
  • MEGA_BYTE_PER_HOUR
  • MEGA_BYTE_PER_MINUTE
  • MEGA_BYTE_PER_SECOND
  • MICRO_SECOND
  • MILLI_CORES
  • MILLI_SECOND
  • MILLI_SECOND_PER_MINUTE
  • MINUTE
  • MONTH
  • MSU
  • NANO_SECOND
  • NANO_SECOND_PER_MINUTE
  • NOT_APPLICABLE
  • PERCENT
  • PER_HOUR
  • PER_MINUTE
  • PER_SECOND
  • PIXEL
  • PROMILLE
  • RATIO
  • SECOND
  • STATE
  • UNSPECIFIED
  • WEEK
  • YEAR

Can be null.

The MetricEventMonitoringStrategy object

A monitoring strategy for a metric event config.

This is the base version of the monitoring strategy, depending on the type, the actual JSON may contain additional fields.

ElementTypeDescription
typestring

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

  • STATIC_THRESHOLD -> MetricEventStaticThresholdMonitoringStrategy
  • AUTO_ADAPTIVE_BASELINE -> MetricEventAutoAdaptiveBaselineMonitoringStrategy
The element can hold these values
  • AUTO_ADAPTIVE_BASELINE
  • STATIC_THRESHOLD
json
{ "type": "STATIC_THRESHOLD", "samples": 3, "violatingSamples": 1, "dealertingSamples": 3, "alertCondition": "BELOW", "alertingOnMissingData": false, "threshold": 99, "unit": "COUNT" }