Skip to content

Read the website error reporting contract

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/public/site-errors
curl --request GET \  --url https://api.xovris.ai/v1/public/site-errors

No token needed: anyone may call this.

Done.

Media typeapplication/json
object
version
required
number
recording
required
boolean
post
required
object
method
required
string
path
required
string
contentTypes
required
Array<string>
fields
required
object
v
required
number
release
required
string
page
required
string
session
required
string
errors
required
string
kinds
required
Array
reports
required
object
method
required
string
path
required
string
contentTypes
required
Array<string>
reportingEndpointsHeader
required
string
types
required
Array<string>
limits
required
object
bodyBytes
required
number
Allowed values: 32768
errorsPerPost
required
number
Allowed values: 10
reportsPerPost
required
number
Allowed values: 20
messageChars
required
number
Allowed values: 1000
stackChars
required
number
Allowed values: 8000
componentStackChars
required
number
Allowed values: 4000
frames
required
number
Allowed values: 50
perAddressPerMinute
required
number
Allowed values: 30
allPerMinute
required
number
Allowed values: 600
keepIntakeDays
required
number
Allowed values: 2
kept
required
Array<string>
neverKept
required
Array<string>
afterTheLimit
required
string

Example

{  "version": 1,  "recording": true,  "post": {    "method": "string",    "path": "string",    "contentTypes": [      "string"    ],    "fields": {      "v": 1,      "release": "string",      "page": "string",      "session": "string",      "errors": "string"    },    "kinds": [      "error"    ]  },  "reports": {    "method": "string",    "path": "string",    "contentTypes": [      "string"    ],    "reportingEndpointsHeader": "string",    "types": [      "string"    ]  },  "limits": {    "bodyBytes": 32768,    "errorsPerPost": 10,    "reportsPerPost": 20,    "messageChars": 1000,    "stackChars": 8000,    "componentStackChars": 4000,    "frames": 50,    "perAddressPerMinute": 30,    "allPerMinute": 600,    "keepIntakeDays": 2  },  "kept": [    "string"  ],  "neverKept": [    "string"  ],  "afterTheLimit": "string"}

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.