Events API v2 - GET a event property
Gets the details about an event property.
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/{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 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 |
|---|---|---|---|---|
| propertyKey | string | The event property key you're inquiring. | path | optional |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Event | Success |
Response body objects
The EventPropertyDetail object
Configuration of an event property.
| Element | Type | Description | Required |
|---|---|---|---|
| key | string | The event property key. | optional |
| displayName | string | The display name of the event property. | optional |
| description | string | A short description of the event property. | optional |
| writable | boolean | Indicates whether the property may be set during event ingestion. | optional |
Response body JSON model
{
"key": "dt.event.description",
"displayName": "Custom description",
"description": "string",
"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.sourceResponse 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