Metric events anomaly detection API - GET an event

Gets parameters of the specified metric event rule.

The request produces an application/json payload.

GET	Managed	`https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/metricEvents/{id}`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/config/v1/anomalyDetection/metricEvents/{id}`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/metricEvents/{id}`

Authentication

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

Parameters

Parameter	Type	Description	In	Required
id	string	The ID of the required metric event.	path	required

Response

To find all JSON models that depend on the type of the model, refer to JSON models.

Response codes

Code	Type	Description
200	MetricEvent	Success

Response body objects

The `MetricEvent` object

The configuration of the metric event.

Element	Type	Description
metadata	ConfigurationMetadata	Metadata useful for debugging Can be `null`.
id	string	The ID of the metric event. Can be `null`.
metricId	string	The ID of the metric evaluated by the metric event. Can be `null`.
metricSelector	string	The metric selector that should be executed. Can be `null`.
name	string	The name of the metric event displayed in the UI.
description	string	The description of the metric event.
aggregationType	string	How the metric data points are aggregated for the evaluation. The timeseries must support this aggregation. The element can hold these values `AVG` `COUNT` `MAX` `MEDIAN` `MIN` `P90` `SUM` `VALUE` Can be `null`.
severity	string	The type of the event to trigger on the threshold violation. The `CUSTOM_ALERT` type is not correlated with other alerts. The `INFO` type does not open a problem. The element can hold these values `AVAILABILITY` `CUSTOM_ALERT` `ERROR` `INFO` `PERFORMANCE` `RESOURCE_CONTENTION` Can be `null`.
enabled	boolean	The metric event is enabled (`true`) or disabled (`false`).
disabledReason	string	The reason of automatic disabling. The `NONE` means config was not disabled automatically. The element can hold these values `METRIC_DEFINITION_INCONSISTENCY` `NONE` `TOO_MANY_DIMS` `TOPX_FORCIBLY_DEACTIVATED` Can be `null`.
warningReason	string	The reason of a warning set on the config. The `NONE` means config has no warnings. The element can hold these values `NONE` `TOO_MANY_DIMS` Can be `null`.
alertingScope	MetricEventAlertingScope[]	Defines the scope of the metric event. Only one filter is allowed per filter type, except for tags, where up to 3 are allowed. The filters are combined by conjunction. Can be `null`.
metricDimensions	MetricEventDimensions[]	Defines the dimensions of the metric to alert on. The filters are combined by conjunction. Can be `null`.
monitoringStrategy	MetricEventMonitoringStrategy	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.
primaryDimensionKey	string	Defines which dimension key should be used for the alertingScope. Can be `null`.
queryOffset	integer	Defines the query offset to adapt the evaluation timeframe for known metric latency. Can be `null`.

The `ConfigurationMetadata` object

Metadata useful for debugging

Element Type Description

configurationVersions

integer[]

Element	Type	Description
configurationVersions	integer[]	A sorted list of the version numbers of the configuration. Can be `null`.
currentConfigurationVersions	string[]	A sorted list of version numbers of the configuration. Can be `null`.
clusterVersion	string	Dynatrace version. Can be `null`.

A sorted list of the version numbers of the configuration.

Can be null.

currentConfigurationVersions

string[]

A sorted list of version numbers of the configuration.

Can be null.

clusterVersion

string

Dynatrace version.

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.

Element Type Description

filterType

string

Element	Type	Description
filterType	string	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`

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

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.

Element Type Description

filterType

string

Element	Type	Description
filterType	string	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`
key	string	The dimensions key on the metric. Can be `null`.

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

key

string

The dimensions key on the metric.

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.

Element Type Description

type

string

Element	Type	Description
type	string	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`

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

Response body JSON model

json
{
  "metadata": {
    "configurationVersions": [
      4,
      2
    ],
    "clusterVersion": "Mock version"
  },
  "metricId": "com.dynatrace.builtin:host.disk.bytesread",
  "name": "My metric event",
  "description": "This is the description for my metric event.",
  "aggregationType": "AVG",
  "severity": "CUSTOM_ALERT",
  "alertingScope": [
    {
      "filterType": "ENTITY_ID",
      "entityId": "HOST-000000000001E240"
    },
    {
      "filterType": "TAG",
      "tagFilter": {
        "context": "CONTEXTLESS",
        "key": "someKey",
        "value": "someValue"
      }
    }
  ],
  "metricDimensions": [
    {
      "filterType": "ENTITY",
      "key": "dt.entity.disk",
      "nameFilter": {
        "value": "diskName",
        "operator": "EQUALS"
      }
    }
  ],
  "enabled": true,
  "disabledReason": "NONE",
  "warningReason": "NONE",
  "monitoringStrategy": {
    "type": "STATIC_THRESHOLD",
    "alertCondition": "ABOVE",
    "samples": 5,
    "violatingSamples": 3,
    "dealertingSamples": 5,
    "threshold": 80,
    "unit": "KILO_BYTE_PER_SECOND"
  }
}

Example

In this example, the request lists the parameters of the High OS CPU usage custom metric event rule.

The API token is passed in the Authorization header.

The rule has the following parameters:

Metric event rule

Curl

shell
curl -X GET \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/anomalyDetection/metricEvents/dynatrace.remote.python.elasticsearch:node.os.cpu_percent:node.os.cpu_percent.high_usage \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

plaintext
https://mySampleEnv.live.dynatrace.com/api/config/v1/anomalyDetection/metricEvents/dynatrace.remote.python.elasticsearch:node.os.cpu_percent:node.os.cpu_percent.high_usage

Response body

json
{
  "metadata": {
    "clusterVersion": "1.164.0.20190211-085949",
    "configurationVersions": [
      2
    ]
  },
  "id": "dynatrace.remote.python.elasticsearch:node.os.cpu_percent:node.os.cpu_percent.high_usage",
  "metricId": "dynatrace.remote.python.elasticsearch:node.os.cpu_percent",
  "name": "High OS CPU usage",
  "description": "The OS CPU usage is {alert_condition} the threshold of {threshold}",
  "aggregationType": "AVG",
  "eventType": "PERFORMANCE",
  "alertCondition": "ABOVE",
  "samples": 5,
  "violatingSamples": 3,
  "dealertingSamples": 5,
  "threshold": 70,
  "enabled": true,
  "tagFilters": []
}

Response code

200

Metric events anomaly detection API - GET an event

Authentication

Parameters

Response

Response codes

Response body objects

The MetricEvent object

The ConfigurationMetadata object

The MetricEventAlertingScope object

The MetricEventDimensions object

The MetricEventMonitoringStrategy object

Response body JSON model

Example

Curl

Request URL

Response body

Response code

The `MetricEvent` object

The `ConfigurationMetadata` object

The `MetricEventAlertingScope` object

The `MetricEventDimensions` object

The `MetricEventMonitoringStrategy` object