Skip to content

See every run a check stored in the last hours, per place, with its response time

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.

GET
/v1/checks/{id}/runs
curl --request GET \  --url https://api.xovris.ai/v1/checks/example/runs \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
ok
required
boolean
since
required
string
hours
required
number
places
required
Array<object>
object
id
required
string
place
required
string
runs
required
Array<object>
object
at
required
string
ok
required
boolean
ms
required
One of:
number
failedPhase
required
One of:
string
said
required
One of:
string
steps
Array<object>
object
name
required
string
ok
required
boolean
ms
required
number
error
string

Example

{  "ok": true,  "since": "string",  "hours": 1,  "places": [    {      "id": "string",      "place": "string",      "runs": [        {          "at": "string",          "ok": true,          "ms": 1,          "failedPhase": "string",          "said": "string",          "steps": [            {              "name": "string",              "ok": true,              "ms": 1,              "error": "string"            }          ]        }      ]    }  ]}

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.