Events API v2 - GET a event property

  • Reference
  • Published Oct 07, 2021

Gets the details about an event property.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/eventProperties/{propertyKey}
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/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

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

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.

filterableboolean

The property can (true) or cannot (false) be used for filtering in the event selector. Usage in event selector: property.<key>("value-1", "value-2")

keystring

The key of the event property.

writableboolean

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

Response body JSON model

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

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

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

Request URL

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

Response body

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

Response code

200