Metric events anomaly detection API - GET all events
Lists all existing metric event rules.
The request produces an application/json payload.
| GET | ManagedDynatrace for Government | 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 | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/metricEvents |
Authentication
To execute this request, you need an access token with ReadConfig scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameters
The request doesn't provide any configurable parameters.
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| includeEntityFilterMetricEvents | boolean | Flag to include metric events with associated entities to the response. Metric events with entity filters aren't compatible across environments. If set to | query | optional |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Stub | Success |
Response body objects
The StubList object
An ordered list of short representations of Dynatrace entities.
| Element | Type | Description |
|---|---|---|
| values | Entity | 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. |
Response body JSON model
{
"values": [
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Dynatrace entity 1",
"description": "Dynatrace entity 1 for the REST API example"
},
{
"id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",
"name": "Dynatrace entity 2"
},
{
"id": "8cdabe77-9e1a-4be8-b3df-269dd6fa9d7f"
}
]
}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 dt0c01.abc123.abcdefjhij1234567890'Request URL
https://mySampleEnv.live.dynatrace.com/api/config/v1/anomalyDetection/metricEvents?includeEntityFilterMetricEvents=trueResponse 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