Settings API - Browser monitor's steps schema table

Published Sep 25, 2025

Browser monitor's steps (`builtin:synthetic.browser.steps)`

Set browser monitor's steps.

Schema ID	Schema groups	Scope
`builtin:synthetic.browser.steps`	-	`SYNTHETIC_TEST` - Synthetic monitor

GET	Managed	`https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:synthetic.browser.steps`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:synthetic.browser.steps`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:synthetic.browser.steps`

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	Type	Description	Required
Steps `steps`	Step[]	-	required

The `Step` object

Property	Type	Description	Required
Type `type`	enum	`NAVIGATE` `CLICK` `TAP` `KEYSTROKES` `JAVASCRIPT` `SELECT_OPTION` `COOKIE`	required
Name `name`	text	-	required
Validation rules `validationRules`	ValidationRule[]	-	required
Target `target`	Target	-	optional
Wait condition `waitCondition`	WaitCondition	-	optional
URL `url`	text	-	optional
Wait condition `authentication`	Authentication	-	optional
List of step cookies `cookies`	CookieEntry[]	-	required
JavaScript `javaScript`	text	-	optional
Button `button`	enum	`MOUSE_LEFT` `MOUSE_MIDDLE` `MOUSE_RIGHT`	optional
Selections `selections`	Selection[]	-	required
Simulate blur event `simulateBlurEvent`	boolean	-	optional
Simulate return key `simulateReturnKey`	boolean	-	optional
Masked `masked`	boolean	-	optional
Text value `textValue`	text	-	required
Credential `credential`	Credential	-	optional

The `ValidationRule` object

Property	Type	Description	Required
Validation type `type`	enum	`TEXT_MATCH` `CONTENT_MATCH` `ELEMENT_MATCH`	required
Matching pattern `matchingPattern`	text	-	required
Is regex `regex`	boolean	-	required
Fail if found `failIfFound`	boolean	-	required
Target `target`	Target	-	optional

The `WaitCondition` object

Property	Type	Description	Required
Wait for `waitFor`	enum	`PAGE_COMPLETE` `TIME` `NETWORK` `VALIDATION` `NEXT_EVENT`	required
Milliseconds `milliseconds`	integer	Wait time in milliseconds.	optional
Timeout in milliseconds `timeoutInMilliseconds`	integer	Timeout in milliseconds.	optional
Validation rule `validationRule`	ValidationRule	-	optional

The `Authentication` object

Property	Type	Description	Required
Type `type`	enum	`HTTP_AUTHENTICATION` `KERBEROS` `WEBFORM`	required
Username `username`	text	-	optional
Password `password`	text	-	optional
Credential `credentialId`	text	-	optional
Domain `domain`	text	-	optional
Authentication server allow list `authServerAllowlist`	text	-	optional

The `CookieEntry` object

Property	Type	Description	Required
Name `name`	text	Enclose placeholder values in brackets, for example {email}	required
Value `value`	text	Enclose placeholder values in brackets, for example {email}	required
Domain `domain`	text	Enclose placeholder values in brackets, for example {email}	required
Path (optional) `path`	text	Enclose placeholder values in brackets, for example {email}	optional

The `Selection` object

Property	Type	Description	Required
Value `value`	text	-	required
Index `index`	integer	-	required

The `Credential` object

Property	Type	Description	Required
Credential id `id`	text	-	required
Credential field `credentialField`	enum	`USERNAME` `PASSWORD` `TOKEN`	optional

The `Target` object

Property	Type	Description	Required
Window `window`	text	-	required
Locators `locators`	Locator[]	-	required

The `Locator` object

Property	Type	Description	Required
Locator type `type`	enum	`CSS` `DOM`	required
Value `value`	text	-	required