Skip to content

Read one check's response time from each place over a day, a week or a month - each bin's runs and failures, the mean time of the runs that answered split into its steps (name lookup, connecting, the secure handshake, the first byte, the transfer), and each place's median and slow tail

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}/phases
curl --request GET \  --url https://api.xovris.ai/v1/checks/example/phases \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
before
One of:
Array<object>
object
id
required
string
runs
required
number
ok
required
number
medianMs
required
One of:
number
p95Ms
required
One of:
number
points
required
Array<object>
object
at
required
string
runs
required
number
ms
required
One of:
number
ok
required
boolean
range
required
string
stepMinutes
required
number
since
required
string
places
required
Array<object>
object
id
required
string
place
required
string
runs
required
number
ok
required
number
medianMs
required
One of:
number
p95Ms
required
One of:
number
firstAt
required
One of:
string
points
required
Array<object>
object
at
required
string
runs
required
number
failed
required
number
failedPhase
required
One of:
string
ms
required
One of:
number
phases
required
One of:
object
resolve
required
number
connect
required
number
tls
required
number
firstByte
required
number
transfer
required
number

Example

{  "before": [    {      "id": "string",      "runs": 1,      "ok": 1,      "medianMs": 1,      "p95Ms": 1,      "points": [        {          "at": "string",          "runs": 1,          "ms": 1        }      ]    }  ],  "ok": true,  "range": "string",  "stepMinutes": 1,  "since": "string",  "places": [    {      "id": "string",      "place": "string",      "runs": 1,      "ok": 1,      "medianMs": 1,      "p95Ms": 1,      "firstAt": "string",      "points": [        {          "at": "string",          "runs": 1,          "failed": 1,          "failedPhase": "string",          "ms": 1,          "phases": {            "resolve": 1,            "connect": 1,            "tls": 1,            "firstByte": 1,            "transfer": 1          }        }      ]    }  ]}

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.