Skip to content

Have Xovris record journeys by walking your site

What you can call today

Every example here runs against api.xovris.ai with a key from your account’s settings. GET /v1/health and GET /v1/public/status answer without one.

POST
/v1/checks/journeys/walk
curl --request POST \  --url https://api.xovris.ai/v1/checks/journeys/walk \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{}'

Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.

Media typeapplication/json
object

Example generated

{}

Done.

Media typeapplication/json
object
none
string
journeys
required
Array<object>
object
add
required
object
method
required
string
path
required
string
body
required
object
locations
string
kind
required
string
url
string
steps
required
Array<object>
object
visit
string
click
string
fill
object
label
required
string
value
required
string
expectText
string
purpose
required
string
Allowed values: sign_in sign_up menu book contact checkout pricing
press
required
string
pages
required
Array<string>
steps
required
Array<object>
object
visit
string
click
string
fill
object
label
required
string
value
required
string
expectText
string
proves
required
string
form
required
boolean
saidBack
required
string
bundleSha256
required
string
broken
required
Array<object>
object
press
required
string
url
required
string
status
required
One of:
number
linksReadBy
string
Allowed values: words meaning
site
required
object
id
required
string
url
required
string
read
required
Array<object>
object
url
required
string
status
required
One of:
number
readAs
string
Allowed values: browser served

Example

{  "none": "string",  "journeys": [    {      "add": {        "method": "string",        "path": "string",        "body": {          "locations": "string",          "kind": "string",          "url": "string",          "steps": [            {              "visit": "string",              "click": "string",              "fill": {                "label": "string",                "value": "string"              },              "expectText": "string"            }          ]        }      },      "purpose": "sign_in",      "press": "string",      "pages": [        "string"      ],      "steps": [        {          "visit": "string",          "click": "string",          "fill": {            "label": "string",            "value": "string"          },          "expectText": "string"        }      ],      "proves": "string",      "form": true,      "saidBack": "string",      "bundleSha256": "string"    }  ],  "broken": [    {      "press": "string",      "url": "string",      "status": 1    }  ],  "linksReadBy": "words",  "site": {    "id": "string",    "url": "string"  },  "read": [    {      "url": "string",      "status": 1    }  ],  "readAs": "browser"}

Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Signed in, but this token or role may not do this. The answer names the permission it needs.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Nothing with that id here, or it belongs to another workspace. Nothing was changed.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Any other refusal or failure. The answer says what happened and what to do next.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Ask Xovris

Open the full page

Your data is never used to train our AI. How your data is kept

A problem is called fixed only once it works again. How each fix is checked

XOVRIS LTD, registered in England and Wales, company number 17499910. Registered office: 66 Paul Street, London EC2A 4NA.