Events API v2 - GET all event properties

Lists all event properties that Dynatrace provides.

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/eventProperties
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/eventProperties
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventProperties

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 properties 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 EventPropertyDetails object

A list of event properties.

Element Type Description
eventProperties EventPropertyDetail[]

A list of event properties.

totalCount integer

The total number of entries in the result.

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.

The EventPropertyDetail object

Configuration of an event property.

Element Type Description
key string

The event property key.

displayName string

The display name of the event property.

description string

A short description of the event property.

writable boolean

Indicates whether the property may be set during event ingestion.

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

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

Request URL

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

Response body

{
  "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