Events API

The Events API delivers details about all uncorrelated events that Dynatrace collects within your environment. Information returned for each event includes attributes about the event source, the entity where the event was collected, and other event-specific details. You can:

  • Receive a global feed of all uncorrelated events in an environment with the GET events feed call.
  • Receive parameters of a specific event with the GET event call.
  • Push external events to your Dynatrace environment with the POST events call.

For an example of how to use this API, see push deployment events from Jenkins.

GET events feed

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
  • Managed https://{your-domain}/e/{your-environment-id}/api/v1/events
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v1/events

GET an event

Lists parameters of the specified event.

The request produces an 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 third-party integrations to one or more monitored entities.

This endpoint enables third-party systems such as CI platforms (Jenkins, Bamboo, Electric Cloud, etc.) to provide additional details for Dynatrace automated root cause analysis.

You can use this endpoint to:

  • Push information-only events from third-party systems 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 (for example, an error rate increase) to trigger the Dynatrace automated root cause analysis engine. Correlation IDs are returned instead of event IDs. These events stay open until the specified timeout expires. To prevent expiration, you can refresh these events by sending the same payload again. The problem-opening event types (sorted by highest to lowest severity) are:
    • AVAILABILITY_EVENT
    • ERROR_EVENT
    • PERFORMANCE_EVENT
    • RESOURCE_CONTENTION

The request consumes and produces an 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