Skip to content

Read a website's quality report

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

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
report
required
One of:
object
error
required
One of:
string
fixRun
required
One of:
object
checkedAt
required
string
applied
required
number
verified
required
boolean
queuedAt
required
One of:
string
nextAt
required
One of:
string
holdsSource
required
boolean
signIn
required
object
secret
required
string
kept
required
boolean
keptAt
required
One of:
string
next
required
string
locked
required
One of:
object
feature
required
string
plan
required
One of:
string
Allowed values: free personal personal_protect business business_protect scale enterprise
message
required
string
next
required
string

Example

{  "report": {},  "error": "string",  "fixRun": {    "checkedAt": "string",    "applied": 1,    "verified": true  },  "queuedAt": "string",  "nextAt": "string",  "holdsSource": true,  "signIn": {    "secret": "string",    "kept": true,    "keptAt": "string",    "next": "string"  },  "locked": {    "feature": "string",    "plan": "free",    "message": "string",    "next": "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.