• Home
  • API
  • Environment
  • Events v2
  • GET an event property

Events API v2 - GET a event property

Gets the details about an event property.

The request produces an application/json payload.

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

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
propertyKeystring

The event property key you're inquiring.

pathrequired

Response

Response codes

CodeTypeDescription
200EventPropertyDetails

Success

Response body objects

The EventPropertyDetails object

Configuration of an event property.

ElementTypeDescription
displayNamestring

The display name of the event property.

writableboolean

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

keystring

The key of the event property.

descriptionstring

A short description of the event property.

Response body JSON model

json
{ "displayName": "Custom description", "writable": true, "key": "dt.event.description", "description": "string" }

Example

In this example, the request queries the details of the Custom source event property.

The API token is passed in the Authorization header.

Curl

bash
curl --request GET \ --url 'https://mySampleEnv.live.dynatrace.com/api/v2/eventProperties/dt.event.source' \ --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

plaintext
https://mySampleEnv.live.dynatrace.com/api/v2/eventProperties/dt.event.source

Response body

json
{ "key": "dt.event.source", "displayName": "Custom source", "description": "The name or ID of the external source of the event", "writable": true }

Response code

200

Related topics
  • Event analytics

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