Settings API - Variables schema table

Variables (`builtin:rum.web.variables`)

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

Schema ID	Schema groups	Scope
`builtin:rum.web.variables`	`group:capturing`	`APPLICATION` - Web application

Retrieve schema via Settings API

GET	Managed	`https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:rum.web.variables`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:rum.web.variables`
	Environment ActiveGate	`https://{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

Property	Label	Type	Description	Required
source	Source	Source	-	required
processingSteps	Processing steps	list	-	required
name	Variable name	text	-	required

Request body objects

The `ProcessingStep` object

Property	Label	Type	Description	Required
type	Type	enum	-	required
patternBefore	Leading delimiter (extract/replace starts here)	text	-	required
searchPattern	Text to search	text	-	required
patternBeforeSearchType	Occurrence	enum	-	required
patternAfter	Trailing delimiter (extract/replace ends here)	text	-	required
patternAfterSearchType	Occurrence	enum	-	required
regularExpression	Regular expression	text	-	required
replacement	Replace with – Optional	text	-	optional
fallbackToSelectedSource	Fall back to selected source	boolean	-	required

The `Source` object

Property	Label	Type	Description	Required
type	Type	enum	-	required
cssSelector	CSS selector	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
jsVariable	JavaScript variable	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
cookieValue	Cookie value	text	Specify a cookie name to capture its value.	required
metaTag	Meta tag name	text	Specify a meta tag name to capture its 'content' value.	required
queryString	Query string	text	Specify a query string parameter to capture its value.	required
requestAttribute	Request attribute name	text	Select an existing request attribute or create a new one.	required