Skip to content

Screens broken after an HTTP 200 by cohort, their fault, repair and proof

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

A token that can read is enough.

Done.

Media typeapplication/json
object
at
required
string
broken
required
Array<object>
object
critical
required
boolean
repair
required
object
finding
required
object
route
required
string
cohort
required
string
repair
required
string
Allowed values: unregister_stale_service_worker roll_back_release flag_off_for_cohort tested_code_release
does
required
string
automatic
required
boolean
verify
required
string
doItYourself
required
string
verified
required
object
pass
required
boolean
seen
required
number
broken
required
number
k
required
number
route
required
string
cohort
required
string
sessions
required
number
of
required
number
reasons
required
Array<string>
firstAt
required
number
detectedWithinMs
required
number
releases
required
Array<string>
faults
required
Array<object>
object
fault
required
string
Allowed values: freeze offline stale_service_worker broken_asset_after_deploy flag_interaction broken_screen_after_200 api_dependency_failing client_server_mismatch
evidence
required
string
sessions
required
number
route
string
flag
string
release
One of:
string
next
required
string

Example

{  "at": "string",  "broken": [    {      "critical": true,      "repair": {        "finding": {          "route": "string",          "cohort": "string"        },        "repair": "unregister_stale_service_worker",        "does": "string",        "automatic": true,        "verify": "string",        "doItYourself": "string"      },      "verified": {        "pass": true,        "seen": 1,        "broken": 1,        "k": 1      },      "route": "string",      "cohort": "string",      "sessions": 1,      "of": 1,      "reasons": [        "string"      ],      "firstAt": 1,      "detectedWithinMs": 1,      "releases": [        "string"      ]    }  ],  "faults": [    {      "fault": "freeze",      "evidence": "string",      "sessions": 1,      "route": "string",      "flag": "string",      "release": "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.