Events API v2 - GET a event property
Gets the details about an event property.
The request produces an application/json
payload.
GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/eventProperties/{propertyKey} |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/eventProperties/{propertyKey} | |
Environment and Cluster ActiveGate (default port 9999) | https://{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
Parameter | Type | Description | In | Required |
---|---|---|---|---|
propertyKey | string | The event property key you're inquiring. | path | required |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | EventPropertyDetails | Success |
Response body objects
The EventPropertyDetails
object
Configuration of an event property.
Element | Type | Description |
---|---|---|
description | string | A short description of the event property. |
displayName | string | The display name of the event property. |
key | string | The key of the event property. |
writable | boolean | The property can ( |
Response body JSON model
1{2 "description": "string",3 "displayName": "Custom description",4 "key": "dt.event.description",5 "writable": true6}
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
1curl --request GET \2 --url 'https://mySampleEnv.live.dynatrace.com/api/v2/eventProperties/dt.event.source' \3 --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
Request URL
1https://mySampleEnv.live.dynatrace.com/api/v2/eventProperties/dt.event.source
Response body
1{2 "key": "dt.event.source",3 "displayName": "Custom source",4 "description": "The name or ID of the external source of the event",5 "writable": true6}
Response code
200