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

Retrieve schema via Settings API

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	The element has these enums `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	-	Required
Wait condition `authentication`	Authentication	-	Optional
List of step cookies `cookies`	CookieEntry[]	-	Required
JavaScript `javaScript`	text	-	Required
Button `button`	enum	The element has these enums `MOUSE_LEFT` `MOUSE_MIDDLE` `MOUSE_RIGHT`	Required
Selections `selections`	Selection[]	-	Required
Input `input`	Input	-	Required
Simulate blur event `simulateBlurEvent`	boolean	-	Required
Simulate return key `simulateReturnKey`	boolean	-	Required

The `ValidationRule` object

Property	Type	Description	Required
Validation type `type`	enum	The element has these enums `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
Type `type`	enum	The element has these enums `PAGE_COMPLETE` `TIME` `NETWORK` `VALIDATION` `NEXT_EVENT`	Required
Milliseconds `milliseconds`	integer	Wait time in milliseconds.	Required
Timeout in milliseconds `timeoutInMilliseconds`	integer	Timeout in milliseconds.	Required
Validation rule `validationRule`	ValidationRule	-	Required

The `Authentication` object

Property	Type	Description	Required
Type `type`	enum	The element has these enums `HTTP_AUTHENTICATION` `KERBEROS` `WEBFORM`	Required
Input type `inputType`	enum	The element has these enums `PLAIN` `SECURE`	Required
Username `username`	text	-	Required
Password `password`	text	-	Required
Credential `credentialId`	text	-	Required
Domain `domain`	text	-	Required
Authentication server allow list `authServerAllowlist`	text	-	Required

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 `Input` object

Property	Type	Description	Required
Input type `type`	enum	The element has these enums `PLAIN` `SECURE`	Required
Credential id `credentialId`	text	-	Required
Credential field `credentialField`	enum	The element has these enums `USERNAME` `PASSWORD` `TOKEN`	Required
Text value `textValue`	text	-	Required
Masked `masked`	boolean	-	Required

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	The element has these enums `CSS` `DOM`	Required
Value `value`	text	-	Required