Metric events anomaly detection API - GET all events

Lists all existing metric event rules.

The request produces an application/json payload.

This request is an early adopter release and may be changed in non compatible way.

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

Parameters

The request doesn't provide any configurable parameters.

Response format

The StubList object

An ordered list of short representations of Dynatrace entities.

Element Type Description
values EntityShortRepresentation[]

An ordered list of short representations of Dynatrace entities.

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element Type Description
id string

The ID of the Dynatrace entity.

name string

The name of the Dynatrace entity.

description string

A short description of the Dynatrace entity.

Example

In this example, the request lists all custom metric event rules of the environment. The response includes events associated with certain entities.

The API token is passed in the Authorization header.

The result is truncated to four entries.

Curl

curl -X GET \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/anomalyDetection/metricEvents?includeEntityFilterMetricEvents=true \
  -H 'Authorization: Api-token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/config/v1/anomalyDetection/metricEvents?includeEntityFilterMetricEvents=true

Response body

{
  "values": [
    {
      "id": "ruxit.perfmon.dotnetV4:%TimeInGC:time_in_gc_alert_high_generic",
      "name": "High GC time",
      "description": "The .NET GC time of {severity} is {alert_condition} the threshold of {threshold}"
    },
    {
      "id": "custom.jmx.hornetq:Queue.MessageCount:jmx_alert",
      "name": "Low message count",
      "description": "Actual number of {severity} queue messages is {alert_condition} the critical threshold of {threshold}"
    },
    {
      "id": "dynatrace.remote.python.elasticsearch:node.os.cpu_percent:node.os.cpu_percent.high_usage",
      "name": "High OS CPU usage",
      "description": "The OS CPU usage is {alert_condition} the threshold of {threshold}"
    },
    {
      "id": "d828b647-7f9a-4664-8401-d59fcb55bd3e",
      "name": "cpu alert",
      "description": "The {metricname} value of {severity} was {alert_condition} your custom threshold of {threshold}."
    }
  ]
}

Response code

200