Lists events that happened within the specified timeframe along with their properties.
The request produces an application/json payload.
| GET | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/events |
| Environment ActiveGateCluster ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/events |
To execute this request, you need an access token with events.read scope.
To learn how to obtain and use it, see Tokens and authentication.
The cursor for the next page of results. You can find it in the nextPageKey field of the previous response.
The first page is always returned if you don't specify the nextPageKey query parameter.
When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
The amount of events in a single response payload.
The maximal allowed page size is 1000.
If not set, 100 is used.
The start of the requested timeframe.
You can use one of the following formats:
2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional.now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week.
You can also specify relative timeframe without an alignment: now-NU.
Supported time units for the relative timeframe are:
m: minutesh: hoursd: daysw: weeksM: monthsy: yearsIf not set, the relative timeframe of two hours is used (now-2h).
The end of the requested timeframe.
You can use one of the following formats:
2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional.now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week.
You can also specify relative timeframe without an alignment: now-NU.
Supported time units for the relative timeframe are:
m: minutesh: hoursd: daysw: weeksM: monthsy: yearsIf not set, the current timestamp is used.
Defines the scope of the query. Only events matching the specified criteria are included in the response.
You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the OR logic applies.
eventId("id-1", "id-2").entityId("id-1", "id-2").status("OPEN") or status("CLOSED"). You can specify only one status.managementZoneId("123", "321").eventType("event-type"). You can specify only one event type. You can fetch the list of possible event types with the GET event types call.correlationId("id-1", "id-2").underMaintenance(true).suppressAlert(true).suppressProblem(true).frequentEvent(true).property.<key>("value-1", "value-2"). Only properties with the filterable property set to true can be used. You can check event properties via the GET event properties call.To set several criteria, separate them with commas (,). Only results matching all criteria are included in the response.
The entity scope of the query. You must set one of these criteria:
type("TYPE")entityId("id"). You can specify several IDs, separated by a comma (entityId("id-1","id-2")). All requested entities must be of the same type.You can add one or more of the following criteria. Values are case-sensitive and the EQUALS operator is used unless otherwise specified.
tag("value"). Tags in [context]key:value, key:value, and value formats are detected and parsed automatically. Any colons (:) that are part of the key or value must be escaped with a backslash(\). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.mzId(123)mzName("value")entityName.equals: performs a non-casesensitive EQUALS query.entityName.startsWith: changes the operator to BEGINS WITH.entityName.in: enables you to provide multiple values. The EQUALS operator applies.caseSensitive(entityName.equals("value")): takes any entity name criterion as an argument and makes the value case-sensitive.healthState("HEALTHY")firstSeenTms.<operator>(now-3h). Use any timestamp format from the from/to parameters.
The following operators are available:
lte: earlier than or at the specified timelt: earlier than the specified timegte: later than or at the specified timegt: later than the specified time<attribute>("value1","value2") and <attribute>.exists(). To fetch the list of available attributes, execute the GET entity type request and check the properties field of the response.fromRelationships.<relationshipName>() and toRelationships.<relationshipName>(). This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the GET entity type request and check the fromRelationships and toRelationships fields.not(<criterion>). Inverts any criterion except for type.For more information, see Entity selector in Dynatrace Documentation.
To set several criteria, separate them with a comma (,). For example, type("HOST"),healthState("HEALTHY"). Only results matching all criteria are included in the response.
The maximum string length is 2,000 characters.
The number of entities that can be selected is limited to 10000.
EventList objectA list of events.
The cursor for the next page of results. Has the value of null on the last page.
Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
The number of entries per page.
The total number of entries in the result.
A list of warnings.
Event objectConfiguration of an event.
The correlation ID of the event.
The timestamp when the event was closed, in UTC milliseconds.
Has the value of null if the event is still active.
The ID of the event.
The type of the event.
If true, the event happens frequently.
A frequent event doesn't raise a problem.
The timestamp when the event was raised, in UTC milliseconds.
The status of the event.
CLOSEDOPENThe alerting status during a maintenance:
false: Alerting works as usual.true: Alerting is disabled.The problem detection status during a maintenance:
false: Problem detection works as usual.true: Problem detection is disabled.The title of the event.
If true, the event happened while the monitored system was under maintenance.
EntityStub objectA short representation of a monitored entity.
The name of the entity.
Not included in the response in case no entity with the relevant ID was found.
EntityId objectA short representation of a monitored entity.
The ID of the entity.
The type of the entity.
METag objectThe tag of a monitored entity.
The origin of the tag, such as AWS or Cloud Foundry.
Custom tags use the CONTEXTLESS value.
The key of the tag.
The string representation of the tag.
The value of the tag.
ManagementZone objectA short representation of a management zone.
The ID of the management zone.
The name of the management zone.
EventProperty objectA property of an event.
The key of the event property.
The value of the event property.
{"events": [{"correlationId": "933613657e1c8fcf","endTime": 1564039524182,"entityId": {"entityId": {"id": "string","type": "string"},"name": "string"},"entityTags": [{"context": "string","key": "string","stringRepresentation": "string","value": "string"}],"eventId": "4293884258445543163_1564039524182","eventType": "LOW_DISK_SPACE","frequentEvent": true,"managementZones": [{"id": "string","name": "string"}],"properties": [{"key": "string","value": "string"}],"startTime": 1564039524182,"status": "OPEN","suppressAlert": true,"suppressProblem": true,"title": "High CPU load on host X","underMaintenance": true}],"nextPageKey": "AQAAABQBAAAABQ==","pageSize": 1,"totalCount": 1,"warnings": ["string"]}
In this example, the request lists all events of the PROCESS_RESTART (eventSelector=eventType("PROCESS_RESTART")) that happened within the last 2 hours (from=now-2h) while a maintenance window was active (eventSelector=underMaintenance(true)). The result is truncated to two events.
The API token is passed in the Authorization header.
curl --request GET \--url 'https://mySampleEnv.live.dynatrace.com/api/v2/events?eventSelector=eventType(%22PROCESS_RESTART%22)%2CunderMaintenance(true)&from=now-2h' \--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
https://mySampleEnv.live.dynatrace.com/api/v2/events?eventSelector=eventType(%22PROCESS_RESTART%22)%2CunderMaintenance(true)&from=now-2h
{"totalCount": 43,"pageSize": 100,"events": [{"eventId": "-6475311485380369979_1628500180000","startTime": 1628500180000,"endTime": 1628500240000,"eventType": "PROCESS_RESTART","title": "Process restart","entityId": {"entityId": {"id": "PROCESS_GROUP_INSTANCE-03F98EA8639FD052","type": "PROCESS_GROUP_INSTANCE"},"name": "IIS app pool dotNetFrontend_easyTravel_x64"},"properties": [{"key": "dt.event.group_label","value": "Process restart"}],"status": "OPEN","entityTags": [{"context": "CONTEXTLESS","key": "easyTravel","stringRepresentation": "easyTravel"},{"context": "CONTEXTLESS","key": "tech","value": "IIS","stringRepresentation": "tech:IIS"},{"context": "CONTEXTLESS","key": "tech","value": ".NET","stringRepresentation": "tech:.NET"},{"context": "CONTEXTLESS","key": "hosts","value": "w-077","stringRepresentation": "hosts:w-077"},{"context": "CONTEXTLESS","key": "Infrastructure","value": "Windows","stringRepresentation": "Infrastructure:Windows"},{"context": "CONTEXTLESS","key": "dotNetFrontend","stringRepresentation": "dotNetFrontend"},],"managementZones": [{"id": "9130632296508575249","name": "Easytravel"},{"id": "-6239538939987181652","name": "frontend"},{"id": "5130731705740636866","name": "Windows"}],"underMaintenance": true,"suppressAlert": true,"suppressProblem": true,"frequentEvent": false},{"eventId": "-231290298591263162_1628500000000","startTime": 1628500000000,"endTime": 1628500060000,"eventType": "PROCESS_RESTART","title": "Process restart","entityId": {"entityId": {"id": "PROCESS_GROUP_INSTANCE-00CA9B0F1AE9BAF8","type": "PROCESS_GROUP_INSTANCE"},"name": "chromedriver_linux64"},"properties": [{"key": "dt.event.group_label","value": "Process restart"}],"status": "CLOSED","entityTags": [{"context": "CONTEXTLESS","key": "Infrastructure","value": "Linux","stringRepresentation": "Infrastructure:Linux"},{"context": "CONTEXTLESS","key": "hosts","value": "l-008","stringRepresentation": "hosts:l-008"}],"managementZones": [{"id": "2631544906797876001","name": "Linux"}],"underMaintenance": true,"suppressAlert": false,"suppressProblem": false,"frequentEvent": false}],"warnings": []}
200