Skip to content

Read the weekly faster-or-cheaper email's contents

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

A token that can read is enough.

Done.

Media typeapplication/json
object
week
required
object
start
required
string
end
required
string
subject
required
string
listed
required
Array<object>
object
id
required
string
kind
required
string
subject
required
string
sentence
required
string
change
required
object
key
additional properties
measure
required
status
required
string
judged
required
Array<object>
object
wayBack
object
revertTo
required
One of:
object
change
required
object
key
additional properties
says
required
string
id
required
string
kind
required
string
subject
required
string
verdict
required
string
says
required
One of:
string
before
required
after
required
judgedAt
required
string
counts
required
object
listed
required
number
improved
required
number
noChange
required
number
regressed
required
number

Example

{  "week": {    "start": "string",    "end": "string"  },  "subject": "string",  "listed": [    {      "id": "string",      "kind": "string",      "subject": "string",      "sentence": "string",      "change": {},      "measure": null,      "status": "string"    }  ],  "judged": [    {      "wayBack": {        "revertTo": {},        "change": {},        "says": "string"      },      "id": "string",      "kind": "string",      "subject": "string",      "verdict": "string",      "says": "string",      "before": null,      "after": null,      "judgedAt": "string"    }  ],  "counts": {    "listed": 1,    "improved": 1,    "noChange": 1,    "regressed": 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.