What features does the events API provide?

This family of endpoints delivers details about all uncorrelated events that Dynatrace collects within a given environment. Information returned for each event includes attributes about the event source, the entity where the event was collected, and other event-specific details. This family of endpoints allows API consumers to:

GET events feed

Lists all the events of your environment, along with their parameters. As the possible number of events can be huge, the response is limited to 150 events. You can narrow down the output by specifying filtering parameters of the request.

The request produces application/json payload.

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

GET event

Lists parameters of the specified event.

The request produces application/json payload.

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

POST events

Pushes custom events from 3rd party integrations to one or more monitored entities.

The intent of this endpoint is to allow 3rd party systems, such as CI platforms (Jenkins, Bamboo, Electric Cloud, etc.) to provide additional detail for Dynatrace automated root cause analysis.

You can use this endpoint to:

  • Push information-only events from 3rd party systems, such as CI platforms (Jenkins, Bamboo, Electric Cloud, etc.) to provide additional information for Dynatrace automated root cause analysis. The time of event closure is already known and the event IDs are returned instantly. The information-only event types are:
    • CUSTOM_ANNOTATION
    • CUSTOM_CONFIGURATION
    • CUSTOM_DEPLOYMENT
    • CUSTOM_INFO
  • Push problem-opening events, like an error rate increase, to trigger the Dynatrace automated root cause analysis engine. These events stay open until the specified timeout expires. Correlation IDs are returned instead of event IDs. You can also refresh these events by sending the same payload again to prevent the expiration. The problem-opening event types are (sorted by severity level, descending):
    • AVAILABILITY_EVENT
    • ERROR_EVENT
    • PERFORMANCE_EVENT
    • RESOURCE_CONTENTION

The request consumes and produces application/json payload.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/v1/events
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v1/events

Event types