Events API v1 - GET events feed

Reference
Deprecated

This API is deprecated. Use the Events API v2 instead.

Lists all of your environment's events and their parameters. Because the possible number of events can be large, the response is limited to 150 events. You can narrow down the output by specifying filtering parameters in your request.

The request produces an application/json payload.

GET	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v1/events`
GET	Environment ActiveGate	`https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/events`

Authentication

To execute this request, you need an access token with DataExport scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
from	integer	Start timestamp of the query, in UTC milliseconds. If not set, 30 days ago from now is used, unless relativeTime is set.	query	Optional
to	integer	End timestamp of the query, in UTC milliseconds. If not set, the current timestamp is used, unless relativeTime is set. The timeframe must not exceed 2 years.	query	Optional
relativeTime	string	Relative timeframe, back from the current time. The element can hold these values `10mins` `15mins` `2hours` `30mins` `3days` `5mins` `6hours` `day` `hour` `min` `month` `week`	query	Optional
eventType	string	Filters the resulting set of events by the event type. The element can hold these values `APPLICATION_JS_FRAMEWORK_DETECTED` `APPLICATION_OVERLOAD_PREVENTION` `AVAILABILITY_EVENT` `CONNECTION_LOST` `CPU_SATURATED` `CUSTOM_ALERT` `CUSTOM_ANNOTATION` `CUSTOM_APPLICATION_OVERLOAD_PREVENTION` `CUSTOM_APP_CRASH_RATE_INCREASED` `CUSTOM_CONFIGURATION` `CUSTOM_DEPLOYMENT` `CUSTOM_INFO` `DATABASE_CONNECTION_FAILURE` `DEPLOYMENT_CHANGED_CHANGE` `DEPLOYMENT_CHANGED_NEW` `DEPLOYMENT_CHANGED_REMOVED` `DYNATRACE_INTERNAL` `EBS_VOLUME_HIGH_LATENCY` `ELASTIC_LOAD_BALANCER_HIGH_BACKEND_FAILURE_RATE` `ELASTIC_LOAD_BALANCER_HIGH_FAILURE_RATE` `ELASTIC_LOAD_BALANCER_HIGH_UNHEALTHY_HOST_RATE` `ERROR_EVENT` `ESXI_HOST_VM_MOTION_ARRIVED` `ESXI_HOST_VM_MOTION_LEFT` `ESXI_HOST_VM_STARTED` `ESXI_START` `ESXI_VM_DISCONNECTED` `ESXI_VM_MOTION` `ESXI_VM_POWER_OFF` `ESXI_VM_START` `FAILURE_RATE_INCREASED` `HIGH_CONNECTIVITY_FAILURES` `HIGH_DROPPED_PACKETS_RATE` `HIGH_GC_ACTIVITY` `HIGH_LATENCY` `HIGH_NETWORK_ERROR_RATE` `HIGH_NETWORK_LOSS_RATE` `HIGH_NETWORK_UTILIZATION` `HOST_CONNECTION_FAILED` `HOST_CONNECTION_LOST` `HOST_DATASTORE_LOW_DISK_SPACE` `HOST_DISK_LOW_INODES` `HOST_GRACEFULLY_SHUTDOWN` `HOST_LOG_AVAILABILITY` `HOST_LOG_ERROR` `HOST_LOG_MATCHED` `HOST_LOG_PERFORMANCE` `HOST_MAINTENANCE` `HOST_NO_CONNECTION` `HOST_OF_SERVICE_UNAVAILABLE` `HOST_SHUTDOWN` `HOST_TIMEOUT` `HTTP_CHECK_GLOBAL_OUTAGE` `HTTP_CHECK_LOCAL_OUTAGE` `HTTP_CHECK_TEST_LOCATION_SLOWDOWN` `INSUFFICIENT_DISK_QUEUE_DEPTH` `JAVASCRIPT_ERROR_RATE_INCREASED` `LAMBDA_FUNCTION_HIGH_ERROR_RATE` `LOG_AVAILABILITY` `LOG_ERROR` `LOG_MATCHED` `LOG_PERFORMANCE` `LOW_DISK_SPACE` `LOW_STORAGE_SPACE` `MARKED_FOR_TERMINATION` `MEMORY_RESOURCES_EXHAUSTED` `MEMORY_SATURATED` `MOBILE_APPLICATION_OVERLOAD_PREVENTION` `MOBILE_APP_CRASH_RATE_INCREASED` `MONITORING_UNAVAILABLE` `MULTI_PROTOCOL_GLOBAL_OUTAGE` `MULTI_PROTOCOL_LOCAL_OUTAGE` `MULTI_PROTOCOL_LOCATION_SLOWDOWN` `OPENSTACK_HOST_VM_SHUTDOWN` `OPENSTACK_HOST_VM_STARTED` `OPENSTACK_KEYSTONE_SLOW` `OPENSTACK_KEYSTONE_UNHEALTHY` `OPENSTACK_VM_LAUNCH_FAILED` `OPENSTACK_VM_MOTION` `OSI_DOCKER_DEVICEMAPPER_LOW_DATA_SPACE` `OSI_DOCKER_DEVICEMAPPER_LOW_METADATA_SPACE` `OVERLOADED_STORAGE` `PERFORMANCE_EVENT` `PGI_CRASHED_INFO` `PGI_HAPROXY_QUEUED_REQUESTS_HIGH` `PGI_HAPROXY_SESSION_USAGE_HIGH` `PGI_LOG_MATCHED` `PGI_MEMDUMP` `PGI_MYSQL_SLOW_QUERIES_RATE_HIGH` `PGI_OF_SERVICE_UNAVAILABLE` `PGI_RMQ_HIGH_FILE_DESC_USAGE` `PGI_RMQ_HIGH_MEM_USAGE` `PGI_RMQ_HIGH_PROCESS_USAGE` `PGI_RMQ_HIGH_SOCKETS_USAGE` `PGI_RMQ_LOW_DISK_SPACE` `PROCESS_CRASHED` `PROCESS_CUSTOM_AVAILABILITY` `PROCESS_CUSTOM_ERROR` `PROCESS_CUSTOM_PERFORMANCE` `PROCESS_GROUP_LOW_INSTANCE_COUNT` `PROCESS_LOG_AVAILABILITY` `PROCESS_LOG_ERROR` `PROCESS_LOG_PERFORMANCE` `PROCESS_RESTART` `PROCESS_UNAVAILABLE` `RDS_AZ_FAILOVER_COMPLETED` `RDS_AZ_FAILOVER_STARTED` `RDS_BACKUP_COMPLETED` `RDS_BACKUP_STARTED` `RDS_OF_SERVICE_UNAVAILABLE` `RDS_RESTART` `RDS_RESTART_SEQUENCE` `RESOURCE_CONTENTION` `SERVICE_RESPONSE_TIME_DEGRADED` `SLOW_DISK` `SYNTHETIC_AVAILABILITY` `SYNTHETIC_NODE_OUTAGE` `SYNTHETIC_PRIVATE_LOCATION_OUTAGE` `SYNTHETIC_SLOWDOWN` `THREADS_RESOURCES_EXHAUSTED` `UNEXPECTED_HIGH_LOAD` `UNEXPECTED_LOW_LOAD` `USER_ACTION_DURATION_DEGRADATION` `VIRTUAL_MACHINE_SHUTDOWN` `WARNING` `WEB_CHECK_GLOBAL_OUTAGE` `WEB_CHECK_LOCAL_OUTAGE`	query	Optional
entityId	string	Filters the resulting set of events to the events, related to the specified Dynatrace entity.	query	Optional
cursor	string	The response is limited to 150 events, so if you want to receive more you can use the cursor to get the next 150. This parameter should be empty when querying for the first time. The cursor key can then be found in the nextCursor field of the previous response. When using the cursor string, it is not necessary to specify the additional parameters, as that info is already encoded within the cursor.	query	Optional

Response

Each event contains at least the following meta information elements and event-specific properties.

Response codes

Code	Type	Description
200	EventQueryResult	Success
4XX	ErrorEnvelope	Client side error.
5XX	ErrorEnvelope	Server side error.

Response body objects

The `EventQueryResult` object

Events of the environment.

Element	Type	Description
events	EventRestEntry[]	The list of events.
from	integer	Start of the query timeframe.
nextCursor	string	The cursor for the next 150 events, fitting the specified criteria. Set this value for the cursor query parameter. Without it you'll get the first 150 events again. You don't have to specify any additional parameters, because the cursor already contains all of them.
to	integer	End of the query timeframe.
totalEventCount	integer	The total amount of events, fitting the specified criteria.

The `EventRestEntry` object

Set of parameters of the event.

Apart from the general properties mentioned here, which each event has, an actual event has a set of metadata that varies depending on the event type.

Element	Type	Description
endTime	integer	The timestamp of the event closure, in UTC milliseconds
entityId	string	The ID of the affected Dynatrace entity.
entityName	string	The name of the affected Dynatrace entity.
eventStatus	string	The state of the event: open or closed. The element can hold these values `CLOSED` `OPEN`
eventType	string	The type of the event. The element can hold these values `APPLICATION_JS_FRAMEWORK_DETECTED` `APPLICATION_OVERLOAD_PREVENTION` `AVAILABILITY_EVENT` `CONNECTION_LOST` `CPU_SATURATED` `CUSTOM_ALERT` `CUSTOM_ANNOTATION` `CUSTOM_APPLICATION_OVERLOAD_PREVENTION` `CUSTOM_APP_CRASH_RATE_INCREASED` `CUSTOM_CONFIGURATION` `CUSTOM_DEPLOYMENT` `CUSTOM_INFO` `DATABASE_CONNECTION_FAILURE` `DEPLOYMENT_CHANGED_CHANGE` `DEPLOYMENT_CHANGED_NEW` `DEPLOYMENT_CHANGED_REMOVED` `DYNATRACE_INTERNAL` `EBS_VOLUME_HIGH_LATENCY` `ELASTIC_LOAD_BALANCER_HIGH_BACKEND_FAILURE_RATE` `ELASTIC_LOAD_BALANCER_HIGH_FAILURE_RATE` `ELASTIC_LOAD_BALANCER_HIGH_UNHEALTHY_HOST_RATE` `ERROR_EVENT` `ESXI_HOST_VM_MOTION_ARRIVED` `ESXI_HOST_VM_MOTION_LEFT` `ESXI_HOST_VM_STARTED` `ESXI_START` `ESXI_VM_DISCONNECTED` `ESXI_VM_MOTION` `ESXI_VM_POWER_OFF` `ESXI_VM_START` `FAILURE_RATE_INCREASED` `HIGH_CONNECTIVITY_FAILURES` `HIGH_DROPPED_PACKETS_RATE` `HIGH_GC_ACTIVITY` `HIGH_LATENCY` `HIGH_NETWORK_ERROR_RATE` `HIGH_NETWORK_LOSS_RATE` `HIGH_NETWORK_UTILIZATION` `HOST_CONNECTION_FAILED` `HOST_CONNECTION_LOST` `HOST_DATASTORE_LOW_DISK_SPACE` `HOST_DISK_LOW_INODES` `HOST_GRACEFULLY_SHUTDOWN` `HOST_LOG_AVAILABILITY` `HOST_LOG_ERROR` `HOST_LOG_MATCHED` `HOST_LOG_PERFORMANCE` `HOST_MAINTENANCE` `HOST_NO_CONNECTION` `HOST_OF_SERVICE_UNAVAILABLE` `HOST_SHUTDOWN` `HOST_TIMEOUT` `HTTP_CHECK_GLOBAL_OUTAGE` `HTTP_CHECK_LOCAL_OUTAGE` `HTTP_CHECK_TEST_LOCATION_SLOWDOWN` `INSUFFICIENT_DISK_QUEUE_DEPTH` `JAVASCRIPT_ERROR_RATE_INCREASED` `LAMBDA_FUNCTION_HIGH_ERROR_RATE` `LOG_AVAILABILITY` `LOG_ERROR` `LOG_MATCHED` `LOG_PERFORMANCE` `LOW_DISK_SPACE` `LOW_STORAGE_SPACE` `MARKED_FOR_TERMINATION` `MEMORY_RESOURCES_EXHAUSTED` `MEMORY_SATURATED` `MOBILE_APPLICATION_OVERLOAD_PREVENTION` `MOBILE_APP_CRASH_RATE_INCREASED` `MONITORING_UNAVAILABLE` `MULTI_PROTOCOL_GLOBAL_OUTAGE` `MULTI_PROTOCOL_LOCAL_OUTAGE` `MULTI_PROTOCOL_LOCATION_SLOWDOWN` `OPENSTACK_HOST_VM_SHUTDOWN` `OPENSTACK_HOST_VM_STARTED` `OPENSTACK_KEYSTONE_SLOW` `OPENSTACK_KEYSTONE_UNHEALTHY` `OPENSTACK_VM_LAUNCH_FAILED` `OPENSTACK_VM_MOTION` `OSI_DOCKER_DEVICEMAPPER_LOW_DATA_SPACE` `OSI_DOCKER_DEVICEMAPPER_LOW_METADATA_SPACE` `OVERLOADED_STORAGE` `PERFORMANCE_EVENT` `PGI_CRASHED_INFO` `PGI_HAPROXY_QUEUED_REQUESTS_HIGH` `PGI_HAPROXY_SESSION_USAGE_HIGH` `PGI_LOG_MATCHED` `PGI_MEMDUMP` `PGI_MYSQL_SLOW_QUERIES_RATE_HIGH` `PGI_OF_SERVICE_UNAVAILABLE` `PGI_RMQ_HIGH_FILE_DESC_USAGE` `PGI_RMQ_HIGH_MEM_USAGE` `PGI_RMQ_HIGH_PROCESS_USAGE` `PGI_RMQ_HIGH_SOCKETS_USAGE` `PGI_RMQ_LOW_DISK_SPACE` `PROCESS_CRASHED` `PROCESS_CUSTOM_AVAILABILITY` `PROCESS_CUSTOM_ERROR` `PROCESS_CUSTOM_PERFORMANCE` `PROCESS_GROUP_LOW_INSTANCE_COUNT` `PROCESS_LOG_AVAILABILITY` `PROCESS_LOG_ERROR` `PROCESS_LOG_PERFORMANCE` `PROCESS_RESTART` `PROCESS_UNAVAILABLE` `RDS_AZ_FAILOVER_COMPLETED` `RDS_AZ_FAILOVER_STARTED` `RDS_BACKUP_COMPLETED` `RDS_BACKUP_STARTED` `RDS_OF_SERVICE_UNAVAILABLE` `RDS_RESTART` `RDS_RESTART_SEQUENCE` `RESOURCE_CONTENTION` `SERVICE_RESPONSE_TIME_DEGRADED` `SLOW_DISK` `SYNTHETIC_AVAILABILITY` `SYNTHETIC_NODE_OUTAGE` `SYNTHETIC_PRIVATE_LOCATION_OUTAGE` `SYNTHETIC_SLOWDOWN` `THREADS_RESOURCES_EXHAUSTED` `UNEXPECTED_HIGH_LOAD` `UNEXPECTED_LOW_LOAD` `USER_ACTION_DURATION_DEGRADATION` `VIRTUAL_MACHINE_SHUTDOWN` `WARNING` `WEB_CHECK_GLOBAL_OUTAGE` `WEB_CHECK_LOCAL_OUTAGE`
id	string	The encoded ID of the event. The format is eventID_startTime. You should use the value from this field when you need an event ID.
impactLevel	string	The impact level of the event. It shows what is affected by the problem: infrastructure, service, or application. The element can hold these values `APPLICATION` `ENVIRONMENT` `INFRASTRUCTURE` `SERVICE`
resourceId	string	The id of the resource the event occurred on.
resourceName	string	The name of the resource the event occurred on.
severityLevel	string	The severity of the event. The element can hold these values `AVAILABILITY` `CUSTOM_ALERT` `ERROR` `MONITORING_UNAVAILABLE` `PERFORMANCE` `RESOURCE_CONTENTION`
startTime	integer	The timestamp of the event detection, in UTC milliseconds.
tags	TagInfo[]	Tags of the Dynatrace entity that raised the event.

The `TagInfo` object

Tag of a Dynatrace entity.

Element Type Description

context

string

Element	Type	Description
context	string	The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the `CONTEXTLESS` value. The element can hold these values `AWS` `AWS_GENERIC` `AZURE` `CLOUD_FOUNDRY` `CONTEXTLESS` `ENVIRONMENT` `GOOGLE_CLOUD` `KUBERNETES`
key	string	The key of the tag. Custom tags have the tag value here.
value	string	The value of the tag. Not applicable to custom tags.

The origin of the tag, such as AWS or Cloud Foundry.

Custom tags use the CONTEXTLESS value.

The element can hold these values

AWS
AWS_GENERIC
AZURE
CLOUD_FOUNDRY
CONTEXTLESS
ENVIRONMENT
GOOGLE_CLOUD
KUBERNETES

key

string

The key of the tag.

Custom tags have the tag value here.

value

string

The value of the tag.

Not applicable to custom tags.

The `ErrorEnvelope` object

Element	Type	Description
error	Error	-

The `Error` object

Element	Type	Description
code	integer	The HTTP status code
constraintViolations	ConstraintViolation[]	A list of constraint violations
message	string	The error message

The `ConstraintViolation` object

A list of constraint violations

Element	Type	Description
location	string	-
message	string	-
parameterLocation	string	- The element can hold these values `HEADER` `PATH` `PAYLOAD_BODY` `QUERY`
path	string	-

Response body JSON models

{
  "events": [
    {
      "endTime": 1521542929000,
      "entityId": "HOST-0000000000000007",
      "entityName": "Example Host",
      "eventStatus": "OPEN",
      "eventType": "SLOW_DISK",
      "id": "5915682011263205071_1521042929000",
      "impactLevel": "INFRASTRUCTURE",
      "severityLevel": "PERFORMANCE",
      "source": "builtin",
      "startTime": 1521042929000,
      "tags": [
        {
          "context": "CONTEXTLESS",
          "key": "exampleTag"
        }
      ]
    },
    {
      "endTime": 1521542929000,
      "entityId": "HOST-0000000000000007",
      "entityName": "Example Host",
      "eventStatus": "OPEN",
      "eventType": "SLOW_DISK",
      "id": "5915682011263205071_1521042929000",
      "impactLevel": "INFRASTRUCTURE",
      "severityLevel": "PERFORMANCE",
      "source": "builtin",
      "startTime": 1521042929000,
      "tags": [
        {
          "context": "CONTEXTLESS",
          "key": "exampleTag"
        }
      ]
    }
  ],
  "from": 1521042929000,
  "nextCursor": "AgEBAAFn5IIFrgEAAAFofwDTrgAAAQAcMTY4N2RhYzViZTAtZmUxODEwOWQ5YTA1MTIyNQ%3D%3D",
  "to": 1521542929000,
  "totalEventCount": 2
}

{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}

Example

In this example, the request queries all the ERROR_EVENT events that occurred during the last 24 hours. The result is truncated to two events.

The API token is passed in the Authorization header.

Curl

curl -X GET \
  'https://mySampleEnv.live.dynatrace.com/api/v1/events?eventType=ERROR_EVENT&relativeTime=day' \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/v1/events?eventType=ERROR_EVENT&relativeTime=day

Response content

{
  "nextEventStartTms": null,
  "nextEventId": null,
  "nextCursor": null,
  "from": 1530703635653,
  "to": 1533295635653,
  "totalEventCount": 25,
  "events": [
    {
      "eventId": -8338439733889003014,
      "startTime": 1532328338475,
      "endTime": 1532328638475,
      "entityId": "HOST-E4D1E5F46E239F21",
      "entityName": "l-8.dyna.trace",
      "severityLevel": "ERROR",
      "impactLevel": "INFRASTRUCTURE",
      "eventType": "ERROR_EVENT",
      "eventStatus": "CLOSED",
      "tags": [
        {
          "context": "CONTEXTLESS",
          "key": "deploy"
        },
        {
          "context": "CONTEXTLESS",
          "key": "room23"
        }
      ],
      "id": "-8338439733889003014_1532328338475",
      "annotationDescription": "testTrigger",
      "correlationId": "67da0a4293956e55",
      "source": "restTest"
    },
    {
      "eventId": 3092227520312561338,
      "startTime": 1531832640600,
      "endTime": 1531836240600,
      "entityId": "HOST-CE6A2253598EA88D",
      "entityName": "q2.docker.l5",
      "severityLevel": "ERROR",
      "impactLevel": "INFRASTRUCTURE",
      "eventType": "ERROR_EVENT",
      "eventStatus": "CLOSED",
      "tags": [
        {
          "context": "CONTEXTLESS",
          "key": "ServiceNow"
        }
      ],
      "id": "3092227520312561338_1531832640600",
      "customProperties": {
        "Property 2": "value 2",
        "Property 1": "value 1",
        "Property 3": "value 3"
      },
      "annotationDescription": "package is damaged",
      "correlationId": "1b79973c6902b486",
      "source": "myAPI"
    }
  ]
}

Response code

200

Events API v1 - GET events feed

Authentication

Parameters

Response

Response codes

Response body objects

The EventQueryResult object

The EventRestEntry object

The TagInfo object

The ErrorEnvelope object

The Error object

The ConstraintViolation object

Response body JSON models

Example

Curl

Request URL

Response content

Response code

Related topics

The `EventQueryResult` object

The `EventRestEntry` object

The `TagInfo` object

The `ErrorEnvelope` object

The `Error` object

The `ConstraintViolation` object