Test detail
Multistep test details
Get the details of one multistep test.
GET /{website-id}/multistep/{test-id}
The result looks like this:
200 OK
{
"id": "27ebx6g5v2",
"alias": "Add to shopping cart",
"created": "2023-05-15T12:50:44.454Z",
"steps": [
{
"type": "navigate",
"target": "https://pagevitals.com/",
"waitUntil": "load"
},
{
"type": "click",
"target": "#menu > a:nth-child(1)",
"waitForNavigation": "on",
"waitUntil": "load"
},
...
]
}The multistep test has these properties:
| Property | Data type | Description |
|---|---|---|
| id | string | The internal ID of the multistep test |
| alias | sting | The displayed name of the multistep test in the admin UI |
| created | datetime | The date and time of when the test was created |
| device | string | Either desktop or mobile |
| steps | array | An array of the steps in the test. See below |
The properties of each item in the steps array are shown here:
| Property | Data type | Description |
|---|---|---|
| type | string | The step type |
| target | string | The target selector of the step type. See how to find the CSS selector here (ms) |
| waitForNavigation | bool | Whether of not the step waits for the browser to navigate to another page |
| waitUntil | string | If waitForNavigation is true, define what exactly to wait for - load, domcontentloaded, networkidle0 or networkidle2, see Puppeteer docs |
Edit multistep test
Edits an existing multistep test. admin
PUT /{website-id}/multistep/{test-id}
{
"alias": "My changed multistep test",
"device": "mobile"
}
Returns the multistep test object:
200 OK
{
"id": "x7wcqghdlo",
"alias": "My changed multistep test",
"device": "mobile"
}Delete multistep test
Removes the multistep test from the website. admin
Note that you will receive no warning and you won't be asked for confirmation. So use this call with care.
DELETE /{website-id}/multistep/{test-id}
If successful, you'll receive a 204 No Content response.