Events API v2 - GET all event types

Lists all types of events that might be raised in your environment.

The request produces an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/v2/eventTypes
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/eventTypes
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventTypes

Authentication

To execute this request, you need the Read events (events.read) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter Type Description In Required
nextPageKey string

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.

query optional
pageSize integer

The amount of event types in a single response payload.

The maximal allowed page size is 500.

If not set, 100 is used.

query optional

Response

Response codes

Code Description
200

Success

Response body

The EventTypeList object

A list of event types.

Element Type Description
eventTypeInfos EventType[]

A list of event types.

nextPageKey string

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.

pageSize integer

The number of entries per page.

totalCount integer

The total number of entries in the result.

The EventType object

Configuration of an event type.

Element Type Description
severityLevel string

The severity level associated with the event type.

type string

The event type.

displayName string

The display name of the event type.

description string

A short description of the event type.

Example

In this example, the request lists all event types that can be created in the mySampleEnv environment. The result is truncated to three entries

The API token is passed in the Authorization header.

Curl

curl --request GET \
  --url 'https://mySampleEnv.live.dynatrace.com/api/v2/eventTypes?pageSize=3' \
  --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Requst URL

https://mySampleEnv.live.dynatrace.com/api/v2/eventTypes?pageSize=3

Response body

{
  "totalCount": 144,
  "pageSize": 3,
  "nextPageKey": "AQAAAGQBAAAAZA==",
  "eventTypeInfos": [
    {
      "type": "APPLICATION_UNEXPECTED_LOW_LOAD",
      "displayName": "Application low traffic",
      "severityLevel": "AVAILABILITY",
      "description": "Unexpected low traffic"
    },
      {
      "type": "MOBILE_APP_CRASH_RATE_INCREASED",
      "displayName": "Mobile app crash rate increase",
      "severityLevel": "ERROR"
    },
    {
      "type": "APPLICATION_SLOWDOWN",
      "displayName": "Application slowdown",
      "severityLevel": "PERFORMANCE",
      "description": "User action duration degradation"
    }
  ]
}

Response code

200