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 ActiveGate | https://{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
Parameter | Type | Description | In | Required |
---|---|---|---|---|
propertyKey | string | The event property key you're inquiring. | path | required |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | Event | Success |
Response body objects
The EventPropertyDetails
object
Configuration of an event property.
Element | Type | Description |
---|---|---|
displayName | string | The display name of the event property. |
writable | boolean | The property can ( |
key | string | The key of the event property. |
description | string | A short description of the event property. |
Response body JSON model
{
"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
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