Settings API - Variables schema table

  • Published Sep 25, 2025

Variables (builtin:rum.web.variables)

Create variables to later use them in naming rules or properties. View examples on variables.

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

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
Source
source		Source-required
Processing steps
processingSteps		ProcessingStep[]-required
Variable name
name		text-required
The Source object
PropertyTypeDescriptionRequired
Type
type		enum
  • PAGE_URL
  • PAGE_URL_ANCHOR
  • PAGE_URL_PATH
  • SOURCE_URL
  • SOURCE_URL_ANCHOR
  • SOURCE_URL_PATH
  • XHR_URL
  • XHR_URL_ANCHOR
  • XHR_URL_PATH
  • TOP_XHR_URL
  • TOP_XHR_URL_ANCHOR
  • TOP_XHR_URL_PATH
  • PAGE_TITLE
  • ELEMENT_IDENTIFIER
  • USER_INTERACTION
  • CSS_SELECTOR
  • JAVASCRIPT_VARIABLE
  • META_TAG
  • COOKIE_VALUE
  • QUERY_STRING
  • KEYPRESS_EVENT
  • REQUEST_ATTRIBUTE
  • CUSTOM_ACTION_NAME
required
CSS selector
cssSelector		text

Specify a CSS selector. This mechanism will capture the first match's innerText/textContent value. To retrieve a specific attribute value of the element, append the '@' symbol, followed by the attribute name. i.e. '#someDomElement@someAttribute'

required
JavaScript variable
jsVariable		text

Specify a JavaScript variable. This variable must be available globally and the capture expression must use dot notation for property reference. i.e. 'someVar.version'. See documentation for details.

required
Cookie value
cookieValue		text

Specify a cookie name to capture its value.

required
Meta tag name
metaTag		text

Specify a meta tag name to capture its 'content' value.

required
Query string
queryString		text

Specify a query string parameter to capture its value.

required
Request attribute name
requestAttribute		text

Select an existing request attribute or create a new one (<your-dynatrace-url>//#settings/requestattributes;reqAttrNew=true).

required
The ProcessingStep object
PropertyTypeDescriptionRequired
Type
type		enum
  • EXTRACT
  • REPLACE
  • REPLACE_TEXT
  • EXTRACT_WITH_REGEX
  • REPLACE_WITH_REGEX
  • REPLACE_IDS
  • CONVERT_TO_LOWER_CASE
  • CONVERT_TO_UPPER_CASE
required
Leading delimiter (extract/replace starts here)
patternBefore		text-required
Text to search
searchPattern		text-required
Occurrence
patternBeforeSearchType		enum
  • FIRST
  • LAST
required
Trailing delimiter (extract/replace ends here)
patternAfter		text-required
Occurrence
patternAfterSearchType		enum
  • FIRST
  • LAST
required
Regular expression
regularExpression		text-required
Replace with – Optional
replacement		text-optional
Fall back to selected source
fallbackToSelectedSource		boolean-required