Try it free

Settings API - Capture properties schema table

  • Published Jul 27, 2026

Capture properties (builtin:rum.web.capture-properties)

Capture and collect properties with metadata-capturing rules.

Schema IDSchema groupsScope
builtin:rum.web.capture-properties-
APPLICATION - Web application
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:rum.web.capture-properties
GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:rum.web.capture-properties
GETEnvironment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:rum.web.capture-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
Captured event properties
capturedEventProperties		CapturedEventProperty[]-Required
Allowed API-reported properties
allowedApiReportedProperties		AllowedApiReportedProperty[]-Required
The CapturedEventProperty object
PropertyTypeDescriptionRequired
Property key
propertyKey		text-Required
Capturing steps
capturingSteps		CapturingStep[]-Required
The AllowedApiReportedProperty object
PropertyTypeDescriptionRequired
Property key
propertyKey		text-Required
Property key validation should be case-insensitive.
caseInsensitivePropertyKey		boolean-Required
The CapturingStep object
PropertyTypeDescriptionRequired
Capturing type
captureType		enum
The element has these enums
  • COOKIE_ACCESSOR
  • DOM_ATTRIBUTE_ACCESSOR
  • JSON_PARSER
  • PROPERTY_ACCESSOR
  • QUERY_SELECTOR
Required
Value to capture
captureValue		text-Required