config [required]
\nobject
Configuration object for a Synthetic mobile test.
initialApplicationArguments
\nobject
Initial application arguments for a mobile test.
<any-key>
\nstring
A single application argument.
variables
\n[object]
Array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID of the variable for global variables.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.
type [required]
\nenum
Type of the configuration variable. \nAllowed enum values: global,text,email
device_ids
\n[string]
Array with the different device IDs used to run the test.
message
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name [required]
\nstring
Name of the test.
options [required]
\nobject
Object describing the extra options for a Synthetic test.
allowApplicationCrash
\nboolean
A boolean to set if an application crash would mark the test as failed.
bindings
\n[object]
Array of bindings used for the mobile test.
principals
\n[string]
List of principals for a mobile test binding.
relation
\nenum
The type of relation for the binding. \nAllowed enum values: editor,viewer
ci
\nobject
CI/CD options for a Synthetic test.
executionRule [required]
\nenum
Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped
defaultStepTimeout
\nint32
The default timeout for steps in the test (in seconds).
device_ids [required]
\n[string]
For mobile test, array with the different device IDs used to run the test.
disableAutoAcceptAlert
\nboolean
A boolean to disable auto accepting alerts.
min_failure_duration
\nint64
Minimum amount of time in failure required to trigger an alert.
mobileApplication [required]
\nobject
Mobile application for mobile synthetics test.
applicationId [required]
\nstring
Application ID of the mobile application.
referenceId [required]
\nstring
Reference ID of the mobile application.
referenceType [required]
\nenum
Reference type for the mobile application for a mobile synthetics test. \nAllowed enum values: latest,version
monitor_name
\nstring
The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
monitor_options
\nobject
Object containing the options for a Synthetic test as a monitor\n(for example, renotification).
escalation_message
\nstring
Message to include in the escalation notification.
notification_preset_name
\nenum
The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
renotify_occurrences
\nint64
The number of times to renotify if the test is still failing.
monitor_priority
\nint32
Integer from 1 (high) to 5 (low) indicating alert severity.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
restricted_roles
\n[string]
A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
scheduling
\nobject
Object containing timeframes and timezone used for advanced scheduling.
timeframes [required]
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day [required]
\nint32
Number representing the day of the week.
from [required]
\nstring
The hour of the day on which scheduling starts.
to [required]
\nstring
The hour of the day on which scheduling ends.
timezone [required]
\nstring
Timezone in which the timeframe is based.
tick_every [required]
\nint64
The frequency at which to run the Synthetic test (in seconds).
verbosity
\nint32
The level of verbosity for the mobile test. This field can not be set by a user.
public_id
\nstring
The public ID of the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
Array of steps for the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
hasNewStepElement
\nboolean
A boolean set to determine if the step has a new step element.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name [required]
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params [required]
\nobject
The parameters of a mobile step.
check
\nenum
Type of assertion to apply in an API test. \nAllowed enum values: equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty
delay
\nint64
Number of milliseconds to wait between inputs in a typeText step type.
direction
\nenum
The direction of the scroll for a scrollToElement step type. \nAllowed enum values: up,down,left,right
element
\nobject
Information about the element used for a step.
context
\nstring
Context of the element.
contextType
\nenum
Type of the context that the element is in. \nAllowed enum values: native,web
elementDescription
\nstring
Description of the element.
multiLocator
\nobject
Multi-locator to find the element.
relativePosition
\nobject
Position of the action relative to the element.
x
\ndouble
The relativePosition on the x axis for the element.
y
\ndouble
The relativePosition on the y axis for the element.
textContent
\nstring
Text content of the element.
userLocator
\nobject
User locator to find the element.
failTestOnCannotLocate
\nboolean
Whether if the test should fail if the element cannot be found.
values
\n[object]
Values of the user locator.
type
\nenum
Type of a user locator. \nAllowed enum values: accessibility-id,id,ios-predicate-string,ios-class-chain,xpath
value
\nstring
Value of a user locator.
viewName
\nstring
Name of the view of the element.
enabled
\nboolean
Boolean to change the state of the wifi for a toggleWiFi step type.
maxScrolls
\nint64
Maximum number of scrolls to do for a scrollToElement step type.
positions
\n[object]
List of positions for the flick step type. The maximum is 10 flicks per step
x
\ndouble
The x position for the flick.
y
\ndouble
The y position for the flick.
subtestPublicId
\nstring
Public ID of the test to be played as part of a playSubTest step type.
value
\n<oneOf>
Values used in the step for in multiple step types.
Option 1
\nstring
Value used in the step for in multiple step types.
Option 2
\nint64
Value used in the step for in multiple step types.
variable
\nobject
Variable object for extractVariable step type.
example [required]
\nstring
An example for the variable.
name [required]
\nstring
The variable name.
withEnter
\nboolean
Boolean to indicate if Enter should be pressed at the end of the typeText step type.
x
\ndouble
Amount to scroll by on the x axis for a scroll step type.
y
\ndouble
Amount to scroll by on the y axis for a scroll step type.
publicId
\nstring
The public ID of the step.
timeout
\nint64
The time before declaring a step failed.
type [required]
\nenum
Step type used in your mobile Synthetic test. \nAllowed enum values: assertElementContent,assertScreenContains,assertScreenLacks,doubleTap,extractVariable,flick,openDeeplink,playSubTest,pressBack,restartApplication,rotate,scroll,scrollToElement,tap,toggleWiFi,typeText,wait
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, mobile. \nAllowed enum values: mobile
default: mobile
config [required]
\nobject
Configuration object for a Synthetic mobile test.
initialApplicationArguments
\nobject
Initial application arguments for a mobile test.
<any-key>
\nstring
A single application argument.
variables
\n[object]
Array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID of the variable for global variables.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.
type [required]
\nenum
Type of the configuration variable. \nAllowed enum values: global,text,email
device_ids
\n[string]
Array with the different device IDs used to run the test.
message [required]
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name [required]
\nstring
Name of the test.
options [required]
\nobject
Object describing the extra options for a Synthetic test.
allowApplicationCrash
\nboolean
A boolean to set if an application crash would mark the test as failed.
bindings
\n[object]
Array of bindings used for the mobile test.
principals
\n[string]
List of principals for a mobile test binding.
relation
\nenum
The type of relation for the binding. \nAllowed enum values: editor,viewer
ci
\nobject
CI/CD options for a Synthetic test.
executionRule [required]
\nenum
Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped
defaultStepTimeout
\nint32
The default timeout for steps in the test (in seconds).
device_ids [required]
\n[string]
For mobile test, array with the different device IDs used to run the test.
disableAutoAcceptAlert
\nboolean
A boolean to disable auto accepting alerts.
min_failure_duration
\nint64
Minimum amount of time in failure required to trigger an alert.
mobileApplication [required]
\nobject
Mobile application for mobile synthetics test.
applicationId [required]
\nstring
Application ID of the mobile application.
referenceId [required]
\nstring
Reference ID of the mobile application.
referenceType [required]
\nenum
Reference type for the mobile application for a mobile synthetics test. \nAllowed enum values: latest,version
monitor_name
\nstring
The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
monitor_options
\nobject
Object containing the options for a Synthetic test as a monitor\n(for example, renotification).
escalation_message
\nstring
Message to include in the escalation notification.
notification_preset_name
\nenum
The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
renotify_occurrences
\nint64
The number of times to renotify if the test is still failing.
monitor_priority
\nint32
Integer from 1 (high) to 5 (low) indicating alert severity.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
restricted_roles
\n[string]
A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
scheduling
\nobject
Object containing timeframes and timezone used for advanced scheduling.
timeframes [required]
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day [required]
\nint32
Number representing the day of the week.
from [required]
\nstring
The hour of the day on which scheduling starts.
to [required]
\nstring
The hour of the day on which scheduling ends.
timezone [required]
\nstring
Timezone in which the timeframe is based.
tick_every [required]
\nint64
The frequency at which to run the Synthetic test (in seconds).
verbosity
\nint32
The level of verbosity for the mobile test. This field can not be set by a user.
public_id
\nstring
The public ID of the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
Array of steps for the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
hasNewStepElement
\nboolean
A boolean set to determine if the step has a new step element.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name [required]
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params [required]
\nobject
The parameters of a mobile step.
check
\nenum
Type of assertion to apply in an API test. \nAllowed enum values: equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty
delay
\nint64
Number of milliseconds to wait between inputs in a typeText step type.
direction
\nenum
The direction of the scroll for a scrollToElement step type. \nAllowed enum values: up,down,left,right
element
\nobject
Information about the element used for a step.
context
\nstring
Context of the element.
contextType
\nenum
Type of the context that the element is in. \nAllowed enum values: native,web
elementDescription
\nstring
Description of the element.
multiLocator
\nobject
Multi-locator to find the element.
relativePosition
\nobject
Position of the action relative to the element.
x
\ndouble
The relativePosition on the x axis for the element.
y
\ndouble
The relativePosition on the y axis for the element.
textContent
\nstring
Text content of the element.
userLocator
\nobject
User locator to find the element.
failTestOnCannotLocate
\nboolean
Whether if the test should fail if the element cannot be found.
values
\n[object]
Values of the user locator.
type
\nenum
Type of a user locator. \nAllowed enum values: accessibility-id,id,ios-predicate-string,ios-class-chain,xpath
value
\nstring
Value of a user locator.
viewName
\nstring
Name of the view of the element.
enabled
\nboolean
Boolean to change the state of the wifi for a toggleWiFi step type.
maxScrolls
\nint64
Maximum number of scrolls to do for a scrollToElement step type.
positions
\n[object]
List of positions for the flick step type. The maximum is 10 flicks per step
x
\ndouble
The x position for the flick.
y
\ndouble
The y position for the flick.
subtestPublicId
\nstring
Public ID of the test to be played as part of a playSubTest step type.
value
\n<oneOf>
Values used in the step for in multiple step types.
Option 1
\nstring
Value used in the step for in multiple step types.
Option 2
\nint64
Value used in the step for in multiple step types.
variable
\nobject
Variable object for extractVariable step type.
example [required]
\nstring
An example for the variable.
name [required]
\nstring
The variable name.
withEnter
\nboolean
Boolean to indicate if Enter should be pressed at the end of the typeText step type.
x
\ndouble
Amount to scroll by on the x axis for a scroll step type.
y
\ndouble
Amount to scroll by on the y axis for a scroll step type.
publicId
\nstring
The public ID of the step.
timeout
\nint64
The time before declaring a step failed.
type [required]
\nenum
Step type used in your mobile Synthetic test. \nAllowed enum values: assertElementContent,assertScreenContains,assertScreenLacks,doubleTap,extractVariable,flick,openDeeplink,playSubTest,pressBack,restartApplication,rotate,scroll,scrollToElement,tap,toggleWiFi,typeText,wait
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, mobile. \nAllowed enum values: mobile
default: mobile
config [required]
\nobject
Configuration object for a Synthetic mobile test.
initialApplicationArguments
\nobject
Initial application arguments for a mobile test.
<any-key>
\nstring
A single application argument.
variables
\n[object]
Array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID of the variable for global variables.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.
type [required]
\nenum
Type of the configuration variable. \nAllowed enum values: global,text,email
device_ids
\n[string]
Array with the different device IDs used to run the test.
message
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name [required]
\nstring
Name of the test.
options [required]
\nobject
Object describing the extra options for a Synthetic test.
allowApplicationCrash
\nboolean
A boolean to set if an application crash would mark the test as failed.
bindings
\n[object]
Array of bindings used for the mobile test.
principals
\n[string]
List of principals for a mobile test binding.
relation
\nenum
The type of relation for the binding. \nAllowed enum values: editor,viewer
ci
\nobject
CI/CD options for a Synthetic test.
executionRule [required]
\nenum
Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped
defaultStepTimeout
\nint32
The default timeout for steps in the test (in seconds).
device_ids [required]
\n[string]
For mobile test, array with the different device IDs used to run the test.
disableAutoAcceptAlert
\nboolean
A boolean to disable auto accepting alerts.
min_failure_duration
\nint64
Minimum amount of time in failure required to trigger an alert.
mobileApplication [required]
\nobject
Mobile application for mobile synthetics test.
applicationId [required]
\nstring
Application ID of the mobile application.
referenceId [required]
\nstring
Reference ID of the mobile application.
referenceType [required]
\nenum
Reference type for the mobile application for a mobile synthetics test. \nAllowed enum values: latest,version
monitor_name
\nstring
The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
monitor_options
\nobject
Object containing the options for a Synthetic test as a monitor\n(for example, renotification).
escalation_message
\nstring
Message to include in the escalation notification.
notification_preset_name
\nenum
The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
renotify_occurrences
\nint64
The number of times to renotify if the test is still failing.
monitor_priority
\nint32
Integer from 1 (high) to 5 (low) indicating alert severity.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
restricted_roles
\n[string]
A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
scheduling
\nobject
Object containing timeframes and timezone used for advanced scheduling.
timeframes [required]
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day [required]
\nint32
Number representing the day of the week.
from [required]
\nstring
The hour of the day on which scheduling starts.
to [required]
\nstring
The hour of the day on which scheduling ends.
timezone [required]
\nstring
Timezone in which the timeframe is based.
tick_every [required]
\nint64
The frequency at which to run the Synthetic test (in seconds).
verbosity
\nint32
The level of verbosity for the mobile test. This field can not be set by a user.
public_id
\nstring
The public ID of the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
Array of steps for the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
hasNewStepElement
\nboolean
A boolean set to determine if the step has a new step element.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name [required]
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params [required]
\nobject
The parameters of a mobile step.
check
\nenum
Type of assertion to apply in an API test. \nAllowed enum values: equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty
delay
\nint64
Number of milliseconds to wait between inputs in a typeText step type.
direction
\nenum
The direction of the scroll for a scrollToElement step type. \nAllowed enum values: up,down,left,right
element
\nobject
Information about the element used for a step.
context
\nstring
Context of the element.
contextType
\nenum
Type of the context that the element is in. \nAllowed enum values: native,web
elementDescription
\nstring
Description of the element.
multiLocator
\nobject
Multi-locator to find the element.
relativePosition
\nobject
Position of the action relative to the element.
x
\ndouble
The relativePosition on the x axis for the element.
y
\ndouble
The relativePosition on the y axis for the element.
textContent
\nstring
Text content of the element.
userLocator
\nobject
User locator to find the element.
failTestOnCannotLocate
\nboolean
Whether if the test should fail if the element cannot be found.
values
\n[object]
Values of the user locator.
type
\nenum
Type of a user locator. \nAllowed enum values: accessibility-id,id,ios-predicate-string,ios-class-chain,xpath
value
\nstring
Value of a user locator.
viewName
\nstring
Name of the view of the element.
enabled
\nboolean
Boolean to change the state of the wifi for a toggleWiFi step type.
maxScrolls
\nint64
Maximum number of scrolls to do for a scrollToElement step type.
positions
\n[object]
List of positions for the flick step type. The maximum is 10 flicks per step
x
\ndouble
The x position for the flick.
y
\ndouble
The y position for the flick.
subtestPublicId
\nstring
Public ID of the test to be played as part of a playSubTest step type.
value
\n<oneOf>
Values used in the step for in multiple step types.
Option 1
\nstring
Value used in the step for in multiple step types.
Option 2
\nint64
Value used in the step for in multiple step types.
variable
\nobject
Variable object for extractVariable step type.
example [required]
\nstring
An example for the variable.
name [required]
\nstring
The variable name.
withEnter
\nboolean
Boolean to indicate if Enter should be pressed at the end of the typeText step type.
x
\ndouble
Amount to scroll by on the x axis for a scroll step type.
y
\ndouble
Amount to scroll by on the y axis for a scroll step type.
publicId
\nstring
The public ID of the step.
timeout
\nint64
The time before declaring a step failed.
type [required]
\nenum
Step type used in your mobile Synthetic test. \nAllowed enum values: assertElementContent,assertScreenContains,assertScreenLacks,doubleTap,extractVariable,flick,openDeeplink,playSubTest,pressBack,restartApplication,rotate,scroll,scrollToElement,tap,toggleWiFi,typeText,wait
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, mobile. \nAllowed enum values: mobile
default: mobile
config [required]
\nobject
Configuration object for a Synthetic mobile test.
initialApplicationArguments
\nobject
Initial application arguments for a mobile test.
<any-key>
\nstring
A single application argument.
variables
\n[object]
Array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID of the variable for global variables.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.
type [required]
\nenum
Type of the configuration variable. \nAllowed enum values: global,text,email
device_ids
\n[string]
Array with the different device IDs used to run the test.
message [required]
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name [required]
\nstring
Name of the test.
options [required]
\nobject
Object describing the extra options for a Synthetic test.
allowApplicationCrash
\nboolean
A boolean to set if an application crash would mark the test as failed.
bindings
\n[object]
Array of bindings used for the mobile test.
principals
\n[string]
List of principals for a mobile test binding.
relation
\nenum
The type of relation for the binding. \nAllowed enum values: editor,viewer
ci
\nobject
CI/CD options for a Synthetic test.
executionRule [required]
\nenum
Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped
defaultStepTimeout
\nint32
The default timeout for steps in the test (in seconds).
device_ids [required]
\n[string]
For mobile test, array with the different device IDs used to run the test.
disableAutoAcceptAlert
\nboolean
A boolean to disable auto accepting alerts.
min_failure_duration
\nint64
Minimum amount of time in failure required to trigger an alert.
mobileApplication [required]
\nobject
Mobile application for mobile synthetics test.
applicationId [required]
\nstring
Application ID of the mobile application.
referenceId [required]
\nstring
Reference ID of the mobile application.
referenceType [required]
\nenum
Reference type for the mobile application for a mobile synthetics test. \nAllowed enum values: latest,version
monitor_name
\nstring
The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
monitor_options
\nobject
Object containing the options for a Synthetic test as a monitor\n(for example, renotification).
escalation_message
\nstring
Message to include in the escalation notification.
notification_preset_name
\nenum
The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
renotify_occurrences
\nint64
The number of times to renotify if the test is still failing.
monitor_priority
\nint32
Integer from 1 (high) to 5 (low) indicating alert severity.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
restricted_roles
\n[string]
A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
scheduling
\nobject
Object containing timeframes and timezone used for advanced scheduling.
timeframes [required]
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day [required]
\nint32
Number representing the day of the week.
from [required]
\nstring
The hour of the day on which scheduling starts.
to [required]
\nstring
The hour of the day on which scheduling ends.
timezone [required]
\nstring
Timezone in which the timeframe is based.
tick_every [required]
\nint64
The frequency at which to run the Synthetic test (in seconds).
verbosity
\nint32
The level of verbosity for the mobile test. This field can not be set by a user.
public_id
\nstring
The public ID of the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
Array of steps for the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
hasNewStepElement
\nboolean
A boolean set to determine if the step has a new step element.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name [required]
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params [required]
\nobject
The parameters of a mobile step.
check
\nenum
Type of assertion to apply in an API test. \nAllowed enum values: equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty
delay
\nint64
Number of milliseconds to wait between inputs in a typeText step type.
direction
\nenum
The direction of the scroll for a scrollToElement step type. \nAllowed enum values: up,down,left,right
element
\nobject
Information about the element used for a step.
context
\nstring
Context of the element.
contextType
\nenum
Type of the context that the element is in. \nAllowed enum values: native,web
elementDescription
\nstring
Description of the element.
multiLocator
\nobject
Multi-locator to find the element.
relativePosition
\nobject
Position of the action relative to the element.
x
\ndouble
The relativePosition on the x axis for the element.
y
\ndouble
The relativePosition on the y axis for the element.
textContent
\nstring
Text content of the element.
userLocator
\nobject
User locator to find the element.
failTestOnCannotLocate
\nboolean
Whether if the test should fail if the element cannot be found.
values
\n[object]
Values of the user locator.
type
\nenum
Type of a user locator. \nAllowed enum values: accessibility-id,id,ios-predicate-string,ios-class-chain,xpath
value
\nstring
Value of a user locator.
viewName
\nstring
Name of the view of the element.
enabled
\nboolean
Boolean to change the state of the wifi for a toggleWiFi step type.
maxScrolls
\nint64
Maximum number of scrolls to do for a scrollToElement step type.
positions
\n[object]
List of positions for the flick step type. The maximum is 10 flicks per step
x
\ndouble
The x position for the flick.
y
\ndouble
The y position for the flick.
subtestPublicId
\nstring
Public ID of the test to be played as part of a playSubTest step type.
value
\n<oneOf>
Values used in the step for in multiple step types.
Option 1
\nstring
Value used in the step for in multiple step types.
Option 2
\nint64
Value used in the step for in multiple step types.
variable
\nobject
Variable object for extractVariable step type.
example [required]
\nstring
An example for the variable.
name [required]
\nstring
The variable name.
withEnter
\nboolean
Boolean to indicate if Enter should be pressed at the end of the typeText step type.
x
\ndouble
Amount to scroll by on the x axis for a scroll step type.
y
\ndouble
Amount to scroll by on the y axis for a scroll step type.
publicId
\nstring
The public ID of the step.
timeout
\nint64
The time before declaring a step failed.
type [required]
\nenum
Step type used in your mobile Synthetic test. \nAllowed enum values: assertElementContent,assertScreenContains,assertScreenLacks,doubleTap,extractVariable,flick,openDeeplink,playSubTest,pressBack,restartApplication,rotate,scroll,scrollToElement,tap,toggleWiFi,typeText,wait
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, mobile. \nAllowed enum values: mobile
default: mobile
config [required]
\nobject
Configuration object for a Synthetic mobile test.
initialApplicationArguments
\nobject
Initial application arguments for a mobile test.
<any-key>
\nstring
A single application argument.
variables
\n[object]
Array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID of the variable for global variables.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.
type [required]
\nenum
Type of the configuration variable. \nAllowed enum values: global,text,email
device_ids
\n[string]
Array with the different device IDs used to run the test.
message
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name [required]
\nstring
Name of the test.
options [required]
\nobject
Object describing the extra options for a Synthetic test.
allowApplicationCrash
\nboolean
A boolean to set if an application crash would mark the test as failed.
bindings
\n[object]
Array of bindings used for the mobile test.
principals
\n[string]
List of principals for a mobile test binding.
relation
\nenum
The type of relation for the binding. \nAllowed enum values: editor,viewer
ci
\nobject
CI/CD options for a Synthetic test.
executionRule [required]
\nenum
Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped
defaultStepTimeout
\nint32
The default timeout for steps in the test (in seconds).
device_ids [required]
\n[string]
For mobile test, array with the different device IDs used to run the test.
disableAutoAcceptAlert
\nboolean
A boolean to disable auto accepting alerts.
min_failure_duration
\nint64
Minimum amount of time in failure required to trigger an alert.
mobileApplication [required]
\nobject
Mobile application for mobile synthetics test.
applicationId [required]
\nstring
Application ID of the mobile application.
referenceId [required]
\nstring
Reference ID of the mobile application.
referenceType [required]
\nenum
Reference type for the mobile application for a mobile synthetics test. \nAllowed enum values: latest,version
monitor_name
\nstring
The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
monitor_options
\nobject
Object containing the options for a Synthetic test as a monitor\n(for example, renotification).
escalation_message
\nstring
Message to include in the escalation notification.
notification_preset_name
\nenum
The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
renotify_occurrences
\nint64
The number of times to renotify if the test is still failing.
monitor_priority
\nint32
Integer from 1 (high) to 5 (low) indicating alert severity.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
restricted_roles
\n[string]
A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
scheduling
\nobject
Object containing timeframes and timezone used for advanced scheduling.
timeframes [required]
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day [required]
\nint32
Number representing the day of the week.
from [required]
\nstring
The hour of the day on which scheduling starts.
to [required]
\nstring
The hour of the day on which scheduling ends.
timezone [required]
\nstring
Timezone in which the timeframe is based.
tick_every [required]
\nint64
The frequency at which to run the Synthetic test (in seconds).
verbosity
\nint32
The level of verbosity for the mobile test. This field can not be set by a user.
public_id
\nstring
The public ID of the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
Array of steps for the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
hasNewStepElement
\nboolean
A boolean set to determine if the step has a new step element.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name [required]
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params [required]
\nobject
The parameters of a mobile step.
check
\nenum
Type of assertion to apply in an API test. \nAllowed enum values: equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty
delay
\nint64
Number of milliseconds to wait between inputs in a typeText step type.
direction
\nenum
The direction of the scroll for a scrollToElement step type. \nAllowed enum values: up,down,left,right
element
\nobject
Information about the element used for a step.
context
\nstring
Context of the element.
contextType
\nenum
Type of the context that the element is in. \nAllowed enum values: native,web
elementDescription
\nstring
Description of the element.
multiLocator
\nobject
Multi-locator to find the element.
relativePosition
\nobject
Position of the action relative to the element.
x
\ndouble
The relativePosition on the x axis for the element.
y
\ndouble
The relativePosition on the y axis for the element.
textContent
\nstring
Text content of the element.
userLocator
\nobject
User locator to find the element.
failTestOnCannotLocate
\nboolean
Whether if the test should fail if the element cannot be found.
values
\n[object]
Values of the user locator.
type
\nenum
Type of a user locator. \nAllowed enum values: accessibility-id,id,ios-predicate-string,ios-class-chain,xpath
value
\nstring
Value of a user locator.
viewName
\nstring
Name of the view of the element.
enabled
\nboolean
Boolean to change the state of the wifi for a toggleWiFi step type.
maxScrolls
\nint64
Maximum number of scrolls to do for a scrollToElement step type.
positions
\n[object]
List of positions for the flick step type. The maximum is 10 flicks per step
x
\ndouble
The x position for the flick.
y
\ndouble
The y position for the flick.
subtestPublicId
\nstring
Public ID of the test to be played as part of a playSubTest step type.
value
\n<oneOf>
Values used in the step for in multiple step types.
Option 1
\nstring
Value used in the step for in multiple step types.
Option 2
\nint64
Value used in the step for in multiple step types.
variable
\nobject
Variable object for extractVariable step type.
example [required]
\nstring
An example for the variable.
name [required]
\nstring
The variable name.
withEnter
\nboolean
Boolean to indicate if Enter should be pressed at the end of the typeText step type.
x
\ndouble
Amount to scroll by on the x axis for a scroll step type.
y
\ndouble
Amount to scroll by on the y axis for a scroll step type.
publicId
\nstring
The public ID of the step.
timeout
\nint64
The time before declaring a step failed.
type [required]
\nenum
Step type used in your mobile Synthetic test. \nAllowed enum values: assertElementContent,assertScreenContains,assertScreenLacks,doubleTap,extractVariable,flick,openDeeplink,playSubTest,pressBack,restartApplication,rotate,scroll,scrollToElement,tap,toggleWiFi,typeText,wait
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, mobile. \nAllowed enum values: mobile
default: mobile
config [required]
\nobject
Configuration object for a Synthetic mobile test.
initialApplicationArguments
\nobject
Initial application arguments for a mobile test.
<any-key>
\nstring
A single application argument.
variables
\n[object]
Array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID of the variable for global variables.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.
type [required]
\nenum
Type of the configuration variable. \nAllowed enum values: global,text,email
device_ids
\n[string]
Array with the different device IDs used to run the test.
message [required]
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name [required]
\nstring
Name of the test.
options [required]
\nobject
Object describing the extra options for a Synthetic test.
allowApplicationCrash
\nboolean
A boolean to set if an application crash would mark the test as failed.
bindings
\n[object]
Array of bindings used for the mobile test.
principals
\n[string]
List of principals for a mobile test binding.
relation
\nenum
The type of relation for the binding. \nAllowed enum values: editor,viewer
ci
\nobject
CI/CD options for a Synthetic test.
executionRule [required]
\nenum
Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped
defaultStepTimeout
\nint32
The default timeout for steps in the test (in seconds).
device_ids [required]
\n[string]
For mobile test, array with the different device IDs used to run the test.
disableAutoAcceptAlert
\nboolean
A boolean to disable auto accepting alerts.
min_failure_duration
\nint64
Minimum amount of time in failure required to trigger an alert.
mobileApplication [required]
\nobject
Mobile application for mobile synthetics test.
applicationId [required]
\nstring
Application ID of the mobile application.
referenceId [required]
\nstring
Reference ID of the mobile application.
referenceType [required]
\nenum
Reference type for the mobile application for a mobile synthetics test. \nAllowed enum values: latest,version
monitor_name
\nstring
The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
monitor_options
\nobject
Object containing the options for a Synthetic test as a monitor\n(for example, renotification).
escalation_message
\nstring
Message to include in the escalation notification.
notification_preset_name
\nenum
The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
renotify_occurrences
\nint64
The number of times to renotify if the test is still failing.
monitor_priority
\nint32
Integer from 1 (high) to 5 (low) indicating alert severity.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
restricted_roles
\n[string]
A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
scheduling
\nobject
Object containing timeframes and timezone used for advanced scheduling.
timeframes [required]
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day [required]
\nint32
Number representing the day of the week.
from [required]
\nstring
The hour of the day on which scheduling starts.
to [required]
\nstring
The hour of the day on which scheduling ends.
timezone [required]
\nstring
Timezone in which the timeframe is based.
tick_every [required]
\nint64
The frequency at which to run the Synthetic test (in seconds).
verbosity
\nint32
The level of verbosity for the mobile test. This field can not be set by a user.
public_id
\nstring
The public ID of the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
Array of steps for the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
hasNewStepElement
\nboolean
A boolean set to determine if the step has a new step element.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name [required]
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params [required]
\nobject
The parameters of a mobile step.
check
\nenum
Type of assertion to apply in an API test. \nAllowed enum values: equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty
delay
\nint64
Number of milliseconds to wait between inputs in a typeText step type.
direction
\nenum
The direction of the scroll for a scrollToElement step type. \nAllowed enum values: up,down,left,right
element
\nobject
Information about the element used for a step.
context
\nstring
Context of the element.
contextType
\nenum
Type of the context that the element is in. \nAllowed enum values: native,web
elementDescription
\nstring
Description of the element.
multiLocator
\nobject
Multi-locator to find the element.
relativePosition
\nobject
Position of the action relative to the element.
x
\ndouble
The relativePosition on the x axis for the element.
y
\ndouble
The relativePosition on the y axis for the element.
textContent
\nstring
Text content of the element.
userLocator
\nobject
User locator to find the element.
failTestOnCannotLocate
\nboolean
Whether if the test should fail if the element cannot be found.
values
\n[object]
Values of the user locator.
type
\nenum
Type of a user locator. \nAllowed enum values: accessibility-id,id,ios-predicate-string,ios-class-chain,xpath
value
\nstring
Value of a user locator.
viewName
\nstring
Name of the view of the element.
enabled
\nboolean
Boolean to change the state of the wifi for a toggleWiFi step type.
maxScrolls
\nint64
Maximum number of scrolls to do for a scrollToElement step type.
positions
\n[object]
List of positions for the flick step type. The maximum is 10 flicks per step
x
\ndouble
The x position for the flick.
y
\ndouble
The y position for the flick.
subtestPublicId
\nstring
Public ID of the test to be played as part of a playSubTest step type.
value
\n<oneOf>
Values used in the step for in multiple step types.
Option 1
\nstring
Value used in the step for in multiple step types.
Option 2
\nint64
Value used in the step for in multiple step types.
variable
\nobject
Variable object for extractVariable step type.
example [required]
\nstring
An example for the variable.
name [required]
\nstring
The variable name.
withEnter
\nboolean
Boolean to indicate if Enter should be pressed at the end of the typeText step type.
x
\ndouble
Amount to scroll by on the x axis for a scroll step type.
y
\ndouble
Amount to scroll by on the y axis for a scroll step type.
publicId
\nstring
The public ID of the step.
timeout
\nint64
The time before declaring a step failed.
type [required]
\nenum
Step type used in your mobile Synthetic test. \nAllowed enum values: assertElementContent,assertScreenContains,assertScreenLacks,doubleTap,extractVariable,flick,openDeeplink,playSubTest,pressBack,restartApplication,rotate,scroll,scrollToElement,tap,toggleWiFi,typeText,wait
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, mobile. \nAllowed enum values: mobile
default: mobile
config [required]
\nobject
Configuration object for a Synthetic mobile test.
initialApplicationArguments
\nobject
Initial application arguments for a mobile test.
<any-key>
\nstring
A single application argument.
variables
\n[object]
Array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID of the variable for global variables.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.
type [required]
\nenum
Type of the configuration variable. \nAllowed enum values: global,text,email
device_ids
\n[string]
Array with the different device IDs used to run the test.
message
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name [required]
\nstring
Name of the test.
options [required]
\nobject
Object describing the extra options for a Synthetic test.
allowApplicationCrash
\nboolean
A boolean to set if an application crash would mark the test as failed.
bindings
\n[object]
Array of bindings used for the mobile test.
principals
\n[string]
List of principals for a mobile test binding.
relation
\nenum
The type of relation for the binding. \nAllowed enum values: editor,viewer
ci
\nobject
CI/CD options for a Synthetic test.
executionRule [required]
\nenum
Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped
defaultStepTimeout
\nint32
The default timeout for steps in the test (in seconds).
device_ids [required]
\n[string]
For mobile test, array with the different device IDs used to run the test.
disableAutoAcceptAlert
\nboolean
A boolean to disable auto accepting alerts.
min_failure_duration
\nint64
Minimum amount of time in failure required to trigger an alert.
mobileApplication [required]
\nobject
Mobile application for mobile synthetics test.
applicationId [required]
\nstring
Application ID of the mobile application.
referenceId [required]
\nstring
Reference ID of the mobile application.
referenceType [required]
\nenum
Reference type for the mobile application for a mobile synthetics test. \nAllowed enum values: latest,version
monitor_name
\nstring
The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
monitor_options
\nobject
Object containing the options for a Synthetic test as a monitor\n(for example, renotification).
escalation_message
\nstring
Message to include in the escalation notification.
notification_preset_name
\nenum
The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
renotify_occurrences
\nint64
The number of times to renotify if the test is still failing.
monitor_priority
\nint32
Integer from 1 (high) to 5 (low) indicating alert severity.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
restricted_roles
\n[string]
A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
scheduling
\nobject
Object containing timeframes and timezone used for advanced scheduling.
timeframes [required]
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day [required]
\nint32
Number representing the day of the week.
from [required]
\nstring
The hour of the day on which scheduling starts.
to [required]
\nstring
The hour of the day on which scheduling ends.
timezone [required]
\nstring
Timezone in which the timeframe is based.
tick_every [required]
\nint64
The frequency at which to run the Synthetic test (in seconds).
verbosity
\nint32
The level of verbosity for the mobile test. This field can not be set by a user.
public_id
\nstring
The public ID of the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
Array of steps for the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
hasNewStepElement
\nboolean
A boolean set to determine if the step has a new step element.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name [required]
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params [required]
\nobject
The parameters of a mobile step.
check
\nenum
Type of assertion to apply in an API test. \nAllowed enum values: equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty
delay
\nint64
Number of milliseconds to wait between inputs in a typeText step type.
direction
\nenum
The direction of the scroll for a scrollToElement step type. \nAllowed enum values: up,down,left,right
element
\nobject
Information about the element used for a step.
context
\nstring
Context of the element.
contextType
\nenum
Type of the context that the element is in. \nAllowed enum values: native,web
elementDescription
\nstring
Description of the element.
multiLocator
\nobject
Multi-locator to find the element.
relativePosition
\nobject
Position of the action relative to the element.
x
\ndouble
The relativePosition on the x axis for the element.
y
\ndouble
The relativePosition on the y axis for the element.
textContent
\nstring
Text content of the element.
userLocator
\nobject
User locator to find the element.
failTestOnCannotLocate
\nboolean
Whether if the test should fail if the element cannot be found.
values
\n[object]
Values of the user locator.
type
\nenum
Type of a user locator. \nAllowed enum values: accessibility-id,id,ios-predicate-string,ios-class-chain,xpath
value
\nstring
Value of a user locator.
viewName
\nstring
Name of the view of the element.
enabled
\nboolean
Boolean to change the state of the wifi for a toggleWiFi step type.
maxScrolls
\nint64
Maximum number of scrolls to do for a scrollToElement step type.
positions
\n[object]
List of positions for the flick step type. The maximum is 10 flicks per step
x
\ndouble
The x position for the flick.
y
\ndouble
The y position for the flick.
subtestPublicId
\nstring
Public ID of the test to be played as part of a playSubTest step type.
value
\n<oneOf>
Values used in the step for in multiple step types.
Option 1
\nstring
Value used in the step for in multiple step types.
Option 2
\nint64
Value used in the step for in multiple step types.
variable
\nobject
Variable object for extractVariable step type.
example [required]
\nstring
An example for the variable.
name [required]
\nstring
The variable name.
withEnter
\nboolean
Boolean to indicate if Enter should be pressed at the end of the typeText step type.
x
\ndouble
Amount to scroll by on the x axis for a scroll step type.
y
\ndouble
Amount to scroll by on the y axis for a scroll step type.
publicId
\nstring
The public ID of the step.
timeout
\nint64
The time before declaring a step failed.
type [required]
\nenum
Step type used in your mobile Synthetic test. \nAllowed enum values: assertElementContent,assertScreenContains,assertScreenLacks,doubleTap,extractVariable,flick,openDeeplink,playSubTest,pressBack,restartApplication,rotate,scroll,scrollToElement,tap,toggleWiFi,typeText,wait
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, mobile. \nAllowed enum values: mobile
default: mobile
config [required]
\nobject
Configuration object for a Synthetic mobile test.
initialApplicationArguments
\nobject
Initial application arguments for a mobile test.
<any-key>
\nstring
A single application argument.
variables
\n[object]
Array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID of the variable for global variables.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.
type [required]
\nenum
Type of the configuration variable. \nAllowed enum values: global,text,email
device_ids
\n[string]
Array with the different device IDs used to run the test.
message [required]
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name [required]
\nstring
Name of the test.
options [required]
\nobject
Object describing the extra options for a Synthetic test.
allowApplicationCrash
\nboolean
A boolean to set if an application crash would mark the test as failed.
bindings
\n[object]
Array of bindings used for the mobile test.
principals
\n[string]
List of principals for a mobile test binding.
relation
\nenum
The type of relation for the binding. \nAllowed enum values: editor,viewer
ci
\nobject
CI/CD options for a Synthetic test.
executionRule [required]
\nenum
Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped
defaultStepTimeout
\nint32
The default timeout for steps in the test (in seconds).
device_ids [required]
\n[string]
For mobile test, array with the different device IDs used to run the test.
disableAutoAcceptAlert
\nboolean
A boolean to disable auto accepting alerts.
min_failure_duration
\nint64
Minimum amount of time in failure required to trigger an alert.
mobileApplication [required]
\nobject
Mobile application for mobile synthetics test.
applicationId [required]
\nstring
Application ID of the mobile application.
referenceId [required]
\nstring
Reference ID of the mobile application.
referenceType [required]
\nenum
Reference type for the mobile application for a mobile synthetics test. \nAllowed enum values: latest,version
monitor_name
\nstring
The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
monitor_options
\nobject
Object containing the options for a Synthetic test as a monitor\n(for example, renotification).
escalation_message
\nstring
Message to include in the escalation notification.
notification_preset_name
\nenum
The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
renotify_occurrences
\nint64
The number of times to renotify if the test is still failing.
monitor_priority
\nint32
Integer from 1 (high) to 5 (low) indicating alert severity.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
restricted_roles
\n[string]
A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
scheduling
\nobject
Object containing timeframes and timezone used for advanced scheduling.
timeframes [required]
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day [required]
\nint32
Number representing the day of the week.
from [required]
\nstring
The hour of the day on which scheduling starts.
to [required]
\nstring
The hour of the day on which scheduling ends.
timezone [required]
\nstring
Timezone in which the timeframe is based.
tick_every [required]
\nint64
The frequency at which to run the Synthetic test (in seconds).
verbosity
\nint32
The level of verbosity for the mobile test. This field can not be set by a user.
public_id
\nstring
The public ID of the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
Array of steps for the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
hasNewStepElement
\nboolean
A boolean set to determine if the step has a new step element.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name [required]
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params [required]
\nobject
The parameters of a mobile step.
check
\nenum
Type of assertion to apply in an API test. \nAllowed enum values: equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty
delay
\nint64
Number of milliseconds to wait between inputs in a typeText step type.
direction
\nenum
The direction of the scroll for a scrollToElement step type. \nAllowed enum values: up,down,left,right
element
\nobject
Information about the element used for a step.
context
\nstring
Context of the element.
contextType
\nenum
Type of the context that the element is in. \nAllowed enum values: native,web
elementDescription
\nstring
Description of the element.
multiLocator
\nobject
Multi-locator to find the element.
relativePosition
\nobject
Position of the action relative to the element.
x
\ndouble
The relativePosition on the x axis for the element.
y
\ndouble
The relativePosition on the y axis for the element.
textContent
\nstring
Text content of the element.
userLocator
\nobject
User locator to find the element.
failTestOnCannotLocate
\nboolean
Whether if the test should fail if the element cannot be found.
values
\n[object]
Values of the user locator.
type
\nenum
Type of a user locator. \nAllowed enum values: accessibility-id,id,ios-predicate-string,ios-class-chain,xpath
value
\nstring
Value of a user locator.
viewName
\nstring
Name of the view of the element.
enabled
\nboolean
Boolean to change the state of the wifi for a toggleWiFi step type.
maxScrolls
\nint64
Maximum number of scrolls to do for a scrollToElement step type.
positions
\n[object]
List of positions for the flick step type. The maximum is 10 flicks per step
x
\ndouble
The x position for the flick.
y
\ndouble
The y position for the flick.
subtestPublicId
\nstring
Public ID of the test to be played as part of a playSubTest step type.
value
\n<oneOf>
Values used in the step for in multiple step types.
Option 1
\nstring
Value used in the step for in multiple step types.
Option 2
\nint64
Value used in the step for in multiple step types.
variable
\nobject
Variable object for extractVariable step type.
example [required]
\nstring
An example for the variable.
name [required]
\nstring
The variable name.
withEnter
\nboolean
Boolean to indicate if Enter should be pressed at the end of the typeText step type.
x
\ndouble
Amount to scroll by on the x axis for a scroll step type.
y
\ndouble
Amount to scroll by on the y axis for a scroll step type.
publicId
\nstring
The public ID of the step.
timeout
\nint64
The time before declaring a step failed.
type [required]
\nenum
Step type used in your mobile Synthetic test. \nAllowed enum values: assertElementContent,assertScreenContains,assertScreenLacks,doubleTap,extractVariable,flick,openDeeplink,playSubTest,pressBack,restartApplication,rotate,scroll,scrollToElement,tap,toggleWiFi,typeText,wait
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, mobile. \nAllowed enum values: mobile
default: mobile
config [required]
\nobject
Configuration object for a Synthetic mobile test.
initialApplicationArguments
\nobject
Initial application arguments for a mobile test.
<any-key>
\nstring
A single application argument.
variables
\n[object]
Array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID of the variable for global variables.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.
type [required]
\nenum
Type of the configuration variable. \nAllowed enum values: global,text,email
device_ids
\n[string]
Array with the different device IDs used to run the test.
message
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name [required]
\nstring
Name of the test.
options [required]
\nobject
Object describing the extra options for a Synthetic test.
allowApplicationCrash
\nboolean
A boolean to set if an application crash would mark the test as failed.
bindings
\n[object]
Array of bindings used for the mobile test.
principals
\n[string]
List of principals for a mobile test binding.
relation
\nenum
The type of relation for the binding. \nAllowed enum values: editor,viewer
ci
\nobject
CI/CD options for a Synthetic test.
executionRule [required]
\nenum
Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped
defaultStepTimeout
\nint32
The default timeout for steps in the test (in seconds).
device_ids [required]
\n[string]
For mobile test, array with the different device IDs used to run the test.
disableAutoAcceptAlert
\nboolean
A boolean to disable auto accepting alerts.
min_failure_duration
\nint64
Minimum amount of time in failure required to trigger an alert.
mobileApplication [required]
\nobject
Mobile application for mobile synthetics test.
applicationId [required]
\nstring
Application ID of the mobile application.
referenceId [required]
\nstring
Reference ID of the mobile application.
referenceType [required]
\nenum
Reference type for the mobile application for a mobile synthetics test. \nAllowed enum values: latest,version
monitor_name
\nstring
The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
monitor_options
\nobject
Object containing the options for a Synthetic test as a monitor\n(for example, renotification).
escalation_message
\nstring
Message to include in the escalation notification.
notification_preset_name
\nenum
The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
renotify_occurrences
\nint64
The number of times to renotify if the test is still failing.
monitor_priority
\nint32
Integer from 1 (high) to 5 (low) indicating alert severity.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
restricted_roles
\n[string]
A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
scheduling
\nobject
Object containing timeframes and timezone used for advanced scheduling.
timeframes [required]
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day [required]
\nint32
Number representing the day of the week.
from [required]
\nstring
The hour of the day on which scheduling starts.
to [required]
\nstring
The hour of the day on which scheduling ends.
timezone [required]
\nstring
Timezone in which the timeframe is based.
tick_every [required]
\nint64
The frequency at which to run the Synthetic test (in seconds).
verbosity
\nint32
The level of verbosity for the mobile test. This field can not be set by a user.
public_id
\nstring
The public ID of the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
Array of steps for the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
hasNewStepElement
\nboolean
A boolean set to determine if the step has a new step element.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name [required]
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params [required]
\nobject
The parameters of a mobile step.
check
\nenum
Type of assertion to apply in an API test. \nAllowed enum values: equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty
delay
\nint64
Number of milliseconds to wait between inputs in a typeText step type.
direction
\nenum
The direction of the scroll for a scrollToElement step type. \nAllowed enum values: up,down,left,right
element
\nobject
Information about the element used for a step.
context
\nstring
Context of the element.
contextType
\nenum
Type of the context that the element is in. \nAllowed enum values: native,web
elementDescription
\nstring
Description of the element.
multiLocator
\nobject
Multi-locator to find the element.
relativePosition
\nobject
Position of the action relative to the element.
x
\ndouble
The relativePosition on the x axis for the element.
y
\ndouble
The relativePosition on the y axis for the element.
textContent
\nstring
Text content of the element.
userLocator
\nobject
User locator to find the element.
failTestOnCannotLocate
\nboolean
Whether if the test should fail if the element cannot be found.
values
\n[object]
Values of the user locator.
type
\nenum
Type of a user locator. \nAllowed enum values: accessibility-id,id,ios-predicate-string,ios-class-chain,xpath
value
\nstring
Value of a user locator.
viewName
\nstring
Name of the view of the element.
enabled
\nboolean
Boolean to change the state of the wifi for a toggleWiFi step type.
maxScrolls
\nint64
Maximum number of scrolls to do for a scrollToElement step type.
positions
\n[object]
List of positions for the flick step type. The maximum is 10 flicks per step
x
\ndouble
The x position for the flick.
y
\ndouble
The y position for the flick.
subtestPublicId
\nstring
Public ID of the test to be played as part of a playSubTest step type.
value
\n<oneOf>
Values used in the step for in multiple step types.
Option 1
\nstring
Value used in the step for in multiple step types.
Option 2
\nint64
Value used in the step for in multiple step types.
variable
\nobject
Variable object for extractVariable step type.
example [required]
\nstring
An example for the variable.
name [required]
\nstring
The variable name.
withEnter
\nboolean
Boolean to indicate if Enter should be pressed at the end of the typeText step type.
x
\ndouble
Amount to scroll by on the x axis for a scroll step type.
y
\ndouble
Amount to scroll by on the y axis for a scroll step type.
publicId
\nstring
The public ID of the step.
timeout
\nint64
The time before declaring a step failed.
type [required]
\nenum
Step type used in your mobile Synthetic test. \nAllowed enum values: assertElementContent,assertScreenContains,assertScreenLacks,doubleTap,extractVariable,flick,openDeeplink,playSubTest,pressBack,restartApplication,rotate,scroll,scrollToElement,tap,toggleWiFi,typeText,wait
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, mobile. \nAllowed enum values: mobile
default: mobile
config [required]
\nobject
Configuration object for a Synthetic mobile test.
initialApplicationArguments
\nobject
Initial application arguments for a mobile test.
<any-key>
\nstring
A single application argument.
variables
\n[object]
Array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID of the variable for global variables.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.
type [required]
\nenum
Type of the configuration variable. \nAllowed enum values: global,text,email
device_ids
\n[string]
Array with the different device IDs used to run the test.
message [required]
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name [required]
\nstring
Name of the test.
options [required]
\nobject
Object describing the extra options for a Synthetic test.
allowApplicationCrash
\nboolean
A boolean to set if an application crash would mark the test as failed.
bindings
\n[object]
Array of bindings used for the mobile test.
principals
\n[string]
List of principals for a mobile test binding.
relation
\nenum
The type of relation for the binding. \nAllowed enum values: editor,viewer
ci
\nobject
CI/CD options for a Synthetic test.
executionRule [required]
\nenum
Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped
defaultStepTimeout
\nint32
The default timeout for steps in the test (in seconds).
device_ids [required]
\n[string]
For mobile test, array with the different device IDs used to run the test.
disableAutoAcceptAlert
\nboolean
A boolean to disable auto accepting alerts.
min_failure_duration
\nint64
Minimum amount of time in failure required to trigger an alert.
mobileApplication [required]
\nobject
Mobile application for mobile synthetics test.
applicationId [required]
\nstring
Application ID of the mobile application.
referenceId [required]
\nstring
Reference ID of the mobile application.
referenceType [required]
\nenum
Reference type for the mobile application for a mobile synthetics test. \nAllowed enum values: latest,version
monitor_name
\nstring
The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
monitor_options
\nobject
Object containing the options for a Synthetic test as a monitor\n(for example, renotification).
escalation_message
\nstring
Message to include in the escalation notification.
notification_preset_name
\nenum
The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
renotify_occurrences
\nint64
The number of times to renotify if the test is still failing.
monitor_priority
\nint32
Integer from 1 (high) to 5 (low) indicating alert severity.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
restricted_roles
\n[string]
A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
scheduling
\nobject
Object containing timeframes and timezone used for advanced scheduling.
timeframes [required]
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day [required]
\nint32
Number representing the day of the week.
from [required]
\nstring
The hour of the day on which scheduling starts.
to [required]
\nstring
The hour of the day on which scheduling ends.
timezone [required]
\nstring
Timezone in which the timeframe is based.
tick_every [required]
\nint64
The frequency at which to run the Synthetic test (in seconds).
verbosity
\nint32
The level of verbosity for the mobile test. This field can not be set by a user.
public_id
\nstring
The public ID of the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
Array of steps for the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
hasNewStepElement
\nboolean
A boolean set to determine if the step has a new step element.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name [required]
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params [required]
\nobject
The parameters of a mobile step.
check
\nenum
Type of assertion to apply in an API test. \nAllowed enum values: equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty
delay
\nint64
Number of milliseconds to wait between inputs in a typeText step type.
direction
\nenum
The direction of the scroll for a scrollToElement step type. \nAllowed enum values: up,down,left,right
element
\nobject
Information about the element used for a step.
context
\nstring
Context of the element.
contextType
\nenum
Type of the context that the element is in. \nAllowed enum values: native,web
elementDescription
\nstring
Description of the element.
multiLocator
\nobject
Multi-locator to find the element.
relativePosition
\nobject
Position of the action relative to the element.
x
\ndouble
The relativePosition on the x axis for the element.
y
\ndouble
The relativePosition on the y axis for the element.
textContent
\nstring
Text content of the element.
userLocator
\nobject
User locator to find the element.
failTestOnCannotLocate
\nboolean
Whether if the test should fail if the element cannot be found.
values
\n[object]
Values of the user locator.
type
\nenum
Type of a user locator. \nAllowed enum values: accessibility-id,id,ios-predicate-string,ios-class-chain,xpath
value
\nstring
Value of a user locator.
viewName
\nstring
Name of the view of the element.
enabled
\nboolean
Boolean to change the state of the wifi for a toggleWiFi step type.
maxScrolls
\nint64
Maximum number of scrolls to do for a scrollToElement step type.
positions
\n[object]
List of positions for the flick step type. The maximum is 10 flicks per step
x
\ndouble
The x position for the flick.
y
\ndouble
The y position for the flick.
subtestPublicId
\nstring
Public ID of the test to be played as part of a playSubTest step type.
value
\n<oneOf>
Values used in the step for in multiple step types.
Option 1
\nstring
Value used in the step for in multiple step types.
Option 2
\nint64
Value used in the step for in multiple step types.
variable
\nobject
Variable object for extractVariable step type.
example [required]
\nstring
An example for the variable.
name [required]
\nstring
The variable name.
withEnter
\nboolean
Boolean to indicate if Enter should be pressed at the end of the typeText step type.
x
\ndouble
Amount to scroll by on the x axis for a scroll step type.
y
\ndouble
Amount to scroll by on the y axis for a scroll step type.
publicId
\nstring
The public ID of the step.
timeout
\nint64
The time before declaring a step failed.
type [required]
\nenum
Step type used in your mobile Synthetic test. \nAllowed enum values: assertElementContent,assertScreenContains,assertScreenLacks,doubleTap,extractVariable,flick,openDeeplink,playSubTest,pressBack,restartApplication,rotate,scroll,scrollToElement,tap,toggleWiFi,typeText,wait
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, mobile. \nAllowed enum values: mobile
default: mobile