Settings API - Custom Properties Capture Restrictions schema table

  • Published May 05, 2025

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
MOBILE_APPLICATION - Mobile App
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:rum.web.capture-custom-properties
GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:rum.web.capture-custom-properties
GETEnvironment 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
Field name validation should be case-insensitive
caseInsensitiveNamingEnabled		boolean-Required
Datatype
fieldDataType		enum
The element has these enums
  • STRING
  • NUMBER
  • BOOLEAN
Required