Skip to content

Read the report of your code reviews for a period

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

A token that can read is enough.

Done.

Media typeapplication/json
object
figures
required
object
from
required
string
to
required
string
reviews
required
number
pullRequests
required
number
repositories
required
number
raised
required
number
bySeverity
required
object
critical
required
number
minor
required
number
major
required
number
trivial
required
number
info
required
number
fixed
required
number
accepted
required
number
dismissed
required
number
abandoned
required
number
open
required
number
actedOn
required
One of:
number
minutesSaved
required
number
basis
required
string
weeks
required
Array<object>
object
start
required
string
reviews
required
number
raised
required
number
fixed
required
number
accepted
required
number
dismissed
required
number
minutesSaved
required
number
empty
required
One of:
object
from
required
string
to
required
string
title
required
string
lines
required
Array<string>

Example

{  "figures": {    "from": "string",    "to": "string",    "reviews": 1,    "pullRequests": 1,    "repositories": 1,    "raised": 1,    "bySeverity": {      "critical": 1,      "minor": 1,      "major": 1,      "trivial": 1,      "info": 1    },    "fixed": 1,    "accepted": 1,    "dismissed": 1,    "abandoned": 1,    "open": 1,    "actedOn": 1,    "minutesSaved": 1,    "basis": "string",    "weeks": [      {        "start": "string",        "reviews": 1,        "raised": 1,        "fixed": 1,        "accepted": 1,        "dismissed": 1,        "minutesSaved": 1      }    ],    "empty": {      "from": "string",      "to": "string"    }  },  "title": "string",  "lines": [    "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.