Events API v2 - GET a event property

Gets the details about an event property.

The request produces an application/json payload.

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

Authentication

To execute this request, you need an access token with Read events (events.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
propertyKey	string	The event property key you're inquiring.	path	required

Response

Response codes

Code	Type	Description
200	EventPropertyDetail	Success

Response body objects

The `EventPropertyDetail` object

Configuration of an event property.

Element	Type	Description
writable	boolean	Indicates whether the property may be set during event ingestion. Can be `null`.
displayName	string	The display name of the event property. Can be `null`.
key	string	The event property key. Can be `null`.
description	string	A short description of the event property. Can be `null`.

Response body JSON model

json
{
  "writable": true,
  "displayName": "Custom description",
  "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

shell
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