Settings API - Custom Properties Capture Restrictions schema table

Custom Properties Capture Restrictions (builtin:rum.web.capture-custom-properties)

Define specific properties to restrict event/session capturing, with options to allow by property name or allow all properties.

Schema IDSchema groupsScope
builtin:rum.web.capture-custom-properties-
APPLICATION - Web application
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:rum.web.capture-custom-properties
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:rum.web.capture-custom-properties
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:rum.web.capture-custom-properties

Authentication

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

Parameters

PropertyTypeDescriptionRequired
List of allowed custom event properties
customEventPropertiesAllowList		CustomProperty[]-required
List of allowed custom session properties
customSessionPropertiesAllowList		CustomProperty[]-required
The CustomProperty object
PropertyTypeDescriptionRequired
Field name
fieldName		text-required
Datatype
fieldDataType		enum
  • STRING
  • NUMBER
  • BOOLEAN
required