• Home
  • API
  • Environment
  • Events v2
  • GET all event properties

Events API v2 - GET all event properties

Lists all event properties that Dynatrace provides.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/eventProperties
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/eventProperties
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventProperties

Authentication

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.

Parameters

ParameterTypeDescriptionInRequired
nextPageKeystring

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.

queryoptional
pageSizeinteger

The amount of event properties in a single response payload.

The maximal allowed page size is 500.

If not set, 100 is used.

queryoptional

Response

Response codes

CodeTypeDescription
200EventPropertiesList

Success

Response body objects

The EventPropertiesList object

A list of event properties.

ElementTypeDescription
eventPropertiesEventPropertyDetails[]

A list of event properties.

nextPageKeystring

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.

pageSizeinteger

The number of entries per page.

totalCountinteger

The total number of entries in the result.

The EventPropertyDetails object

Configuration of an event property.

ElementTypeDescription
descriptionstring

A short description of the event property.

displayNamestring

The display name of the event property.

keystring

The key of the event property.

writableboolean

The property can (true) or cannot (false) be set during event ingestion.

Response body JSON model

json
{ "eventProperties": [ { "description": "string", "displayName": "Custom description", "key": "dt.event.description", "writable": true } ], "nextPageKey": "AQAAABQBAAAABQ==", "pageSize": 1, "totalCount": 1 }

Example

In this example, the request lists all available event properties that are available in the mySampleEnv environment. The result is truncated to three entries

The API token is passed in the Authorization header.

Curl

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

Request URL

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

Response body

json
{ "totalCount": 23, "pageSize": 3, "nextPageKey": "AQAAAAMBAAAAAw==", "eventProperties": [ { "key": "dt.event.allow_davis_merge", "displayName": "Allow Davis merge", "description": "Allow Davis AI to merge this event into existing problems (true) or force creating a new problem (false)", "writable": true }, { "key": "dt.event.baseline.service_method", "displayName": "Baseline affected service method", "description": "Lists affected service methods of the triggered service event", "writable": false }, { "key": "dt.event.baseline.total_load", "displayName": "Baseline total load", "description": "The load (calls per minute) of the entire service or application for triggered event", "writable": false } ] }

Response code

200

Related topics
  • Event analytics

    Gain an understanding of the Events section on each host, process, and service overview page.