Documentation forSolarWinds Observability SaaS

Synthetic transaction API commands

API commands for Synthetic transactions are separated into instructions, Iframe instructions, and validations. See the tables below for command examples.

API Instructions

Command API Command
Go to url URL

OPEN 

{

   "command": "OPEN",

   "target": "string"

}
click element

CLICK

{
   "command": "CLICK",
   "target": "string",
   "displayText": "string"
}
click XPATH()

CLICK

{
   "command": "CLICK",
   "target": "string",
   "displayText": "string"
}
fill in field element with text/secret

TYPE

{
   "command": "TYPE",
   "target": "string",
   "displayText": "string",
   "value": "string"
}
fill in field XPATH() with text/secret 
{  
   "command": "TYPE",

   "target": "string",

   "displayText": "string",

   "value": "string"

}
check radio/checkbox

CHECK 

{ 
   "command": 
   "CHECK", 
   "target": 
   "string", 
   "displayText": "string"

}
uncheck radio/checkbox

UNCHECK

{
   "command": "UNCHECK",
   "target": "string",
   "displayText": "string"
}
sleep for number seconds

PAUSE

{
   "command": "PAUSE",
   "target": "string",
   "displayText": "string"
}
select dropdown element with item

SELECT

{
   "command": "SELECT",
   "target": "string",
   "displayText": "string",
   "value": "string"
}
select dropdown XPATH() with item

SELECT

{
   "command": "SELECT",
   "target": "string",
   "displayText": "string",
   "value": "string"
}
submit form form

SUBMIT

{
   "command": "SUBMIT",
   "target": "string",
   "displayText": "string"
}
wait for element element to exist for

WAIT_FOR_ELEMENT_PRESENT

{
   "command": "WAIT_FOR_ELEMENT_PRESENT",
   "target": "string",
   "displayText": "string",
   "value": "string"
}
wait for XPATH() to exist for

WAIT_FOR_ELEMENT_PRESENT

{
   "command": "WAIT_FOR_ELEMENT_PRESENT",
   "target": "string",
   "displayText": "string",
   "value": "string"
}
wait for element element to contain text text

SWO_WAIT_FOR_ELEMENT_TEXT_CONTAINS

{
   "command": "SWO_WAIT_FOR_ELEMENT_TEXT_CONTAINS",
   "target": "string",
   "displayText": "string",
   "value": "string"
}
wait for XPATH() to contain text text

SWO_WAIT_FOR_ELEMENT_TEXT_CONTAINS

{
   "command": "SWO_WAIT_FOR_ELEMENT_TEXT_CONTAINS",
   "target": "string",
   "displayText": "string",
   "value": "string"
}

API iframe instructions

Command API Command
select frame XPATH()

SELECT_FRAME

{
   "command": "SELECT_FRAME",
   "target": "string",
   "displayText": "string"
}
select frame TOP_FRAME

SELECT_FRAME

{
   "command": "SELECT_FRAME",
   "target": "TOP_FRAME",
   "displayText": "TOP_FRAME"
}
select frame PARENT_FRAME

SELECT_FRAME

{
   "command": "SELECT_FRAME",
   "target": "PARENT_FRAME",
   "displayText": "PARENT_FRAME"
}

API Validations

Command API Command
URL should be URL

SWO_ASSERT_URL

{
   "command": "SWO_ASSERT_URL",
   "target": "string"
}
element should exist

ASSERT_ELEMENT_PRESENT

{
   "command": "ASSERT_ELEMENT_PRESENT",
   "target": "string",
   "displayText": "string"
}
XPATH() should exist

ASSERT_ELEMENT_PRESENT

{
   "command": "ASSERT_ELEMENT_PRESENT",
   "target": "string",
   "displayText": "string"
}
element should not exist

ASSERT_ELEMENT_NOT_PRESENT

{
   "command": "ASSERT_ELEMENT_NOT_PRESENT",
   "target": "string",
   "displayText": "string"
}
XPATH() should not exist

ASSERT_ELEMENT_NOT_PRESENT

{
   "command": "ASSERT_ELEMENT_NOT_PRESENT",
   "target": "string",
   "displayText": "string"
}
element should contain text

SWO_ASSERT_TEXT_CONTAINS

{
   "command": "SWO_ASSERT_TEXT_CONTAINS",
   "target": "string",
   "displayText": "string",
   "value": "string"
}
XPATH() should contain text

SWO_ASSERT_TEXT_CONTAINS

{
   "command": "SWO_ASSERT_TEXT_CONTAINS",
   "target": "string",
   "displayText": "string",
   "value": "string"
}
element should not contain text

SWO_ASSERT_TEXT_NOT_CONTAINS

{
   "command": "SWO_ASSERT_TEXT_NOT_CONTAINS",
   "target": "string",
   "displayText": "string",
   "value": "string"
}
XPATH() should not contain text

SWO_ASSERT_TEXT_NOT_CONTAINS

{
   "command": "SWO_ASSERT_TEXT_NOT_CONTAINS",
   "target": "string",
   "displayText": "string",
   "value": "string"
}
Assert checked radio/checkbox

ASSERT_CHECKED

{
   "command": "ASSERT_CHECKED",
   "target": "string",
   "displayText": "string",
   "value": "string"
}
Assert not checked radio/checkbox

ASSERT_NOT_CHECKED

{
   "command": "ASSERT_NOT_CHECKED",
   "target": "string",
   "displayText": "string",
   "value": "string"
}
Drop-down element with value value should be selected

ASSERT_SELECTED_VALUE

{
   "command": "ASSERT_SELECTED_VALUE",
   "target": "string",
   "displayText": "string",
   "value": "string"
}
Drop-down XPATH() with value value should be selected

ASSERT_SELECTED_VALUE

{
   "command": "ASSERT_SELECTED_VALUE",
   "target": "string",
   "displayText": "string",
   "value": "string"
}
Drop-down element with value value should not be selected

ASSERT_NOT_SELECTED_VALUE

{
   "command": "ASSERT_NOT_SELECTED_VALUE",
   "target": "string",
   "displayText": "string",
   "value": "string"
}
Drop-down XPATH() with value value should not be selected

ASSERT_NOT_SELECTED_VALUE

{
   "command": "ASSERT_NOT_SELECTED_VALUE",
   "target": "string",
   "displayText": "string",
   "value": "string"
}
Element {element} should not have {text}

ASSERT_NOT_TEXT

{
"command": "ASSERT_NOT_TEXT",
"target": "string",
"displayText": "string",
"value": "string"
}
Element {element} should have {text}

ASSERT_TEXT

{
   "command": "ASSERT_TEXT",
   "target": "string",
   "displayText": "string",
   "value": "string"
}
Text field {element} should have {text}

ASSERT_VALUE

{
   "command": "ASSERT_VALUE",
   "target": "string",
   "displayText": "string",
   "value": "string"
}
Text field {element} should contain {text}

SWO_ASSERT_VALUE_CONTAINS

{
   "command": "SWO_ASSERT_VALUE_CONTAINS",
   "target": "string",
   "displayText": "string",
   "value": "string"
}
Text field {element} should not contain {text}

SWO_ASSERT_VALUE_NOT_CONTAINS

{
   "command": "SWO_ASSERT_VALUE_NOT_CONTAINS",
   "target": "string",
   "displayText": "string",
   "value": "string"
}