Skip to content

See your code reviews over time - raised, fixed, proven and dismissed

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

A token that can read is enough.

Done.

Media typeapplication/json
object
ladder
required
One of:
object
on
required
boolean
plan
required
string
planEvery
required
One of:
string
aiReads
required
boolean
cadence
required
object
everyMs
required
One of:
number
words
required
One of:
string
setBy
required
One of:
string
setAt
required
One of:
string
yours
required
boolean
adapts
required
boolean
choices
required
Array<object>
object
everyMs
required
number
words
required
string
allowed
required
boolean
needs
required
One of:
string
things
required
Array<object>
object
thingKey
required
string
everyMs
required
number
words
required
string
running
required
One of:
object
id
required
string
startedAt
required
string
endedAt
required
One of:
string
state
required
string
Allowed values: done failed running
why
required
string
Allowed values: cadence asked
every
required
One of:
string
everyMs
required
One of:
number
things
required
number
readings
required
number
skipped
required
number
findings
required
number
worst
required
One of:
string
Allowed values: high medium low critical
bySeverity
required
object
high
required
number
medium
required
number
low
required
number
critical
required
number
fixes
required
number
changed
required
number
passes
required
Array<object>
object
id
required
string
startedAt
required
string
endedAt
required
One of:
string
state
required
string
Allowed values: done failed running
why
required
string
Allowed values: cadence asked
every
required
One of:
string
everyMs
required
One of:
number
things
required
number
readings
required
number
skipped
required
number
findings
required
number
worst
required
One of:
string
Allowed values: high medium low critical
bySeverity
required
object
high
required
number
medium
required
number
low
required
number
critical
required
number
fixes
required
number
changed
required
number
nextAt
required
One of:
string
off
required
One of:
object
message
required
string
next
required
string
days
required
number
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
connected
required
boolean
notice
required
string
recent
required
Array<object>
object
id
required
string
repo
required
string
number
required
number
headSha
required
string
at
required
string
files
required
number
additions
required
number
deletions
required
number
effortMinutes
required
number
risk
required
string
Allowed values: high medium low
findings
required
number
findings
required
Array<object>
object
evidence
required
object
untrusted
required
boolean
scanned
required
boolean
text
required
string
repo
required
string
number
required
number
id
required
string
runId
required
string
rule
required
string
title
required
string
severity
required
string
Allowed values: critical minor major trivial info
category
required
string
Allowed values: data security stability correctness performance maintainability
file
required
string
line
required
number
source
required
string
Allowed values: rule ci guideline weakening production
firstSeenAt
required
string
outcome
required
string
Allowed values: open fixed dismissed accepted abandoned
outcomeAt
required
One of:
string
outcomeBy
required
One of:
string
more
required
number

Example

{  "ladder": {    "on": true,    "plan": "string",    "planEvery": "string",    "aiReads": true,    "cadence": {      "everyMs": 1,      "words": "string",      "setBy": "string",      "setAt": "string",      "yours": true,      "adapts": true,      "choices": [        {          "everyMs": 1,          "words": "string",          "allowed": true,          "needs": "string"        }      ]    },    "things": [      {        "thingKey": "string",        "everyMs": 1,        "words": "string"      }    ],    "running": {      "id": "string",      "startedAt": "string",      "endedAt": "string",      "state": "done",      "why": "cadence",      "every": "string",      "everyMs": 1,      "things": 1,      "readings": 1,      "skipped": 1,      "findings": 1,      "worst": "high",      "bySeverity": {        "high": 1,        "medium": 1,        "low": 1,        "critical": 1      },      "fixes": 1,      "changed": 1    },    "passes": [      {        "id": "string",        "startedAt": "string",        "endedAt": "string",        "state": "done",        "why": "cadence",        "every": "string",        "everyMs": 1,        "things": 1,        "readings": 1,        "skipped": 1,        "findings": 1,        "worst": "high",        "bySeverity": {          "high": 1,          "medium": 1,          "low": 1,          "critical": 1        },        "fixes": 1,        "changed": 1      }    ],    "nextAt": "string",    "off": {      "message": "string",      "next": "string"    }  },  "days": 1,  "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"    }  },  "connected": true,  "notice": "string",  "recent": [    {      "id": "string",      "repo": "string",      "number": 1,      "headSha": "string",      "at": "string",      "files": 1,      "additions": 1,      "deletions": 1,      "effortMinutes": 1,      "risk": "high",      "findings": 1    }  ],  "findings": [    {      "evidence": {        "untrusted": true,        "scanned": true,        "text": "string"      },      "repo": "string",      "number": 1,      "id": "string",      "runId": "string",      "rule": "string",      "title": "string",      "severity": "critical",      "category": "data",      "file": "string",      "line": 1,      "source": "rule",      "firstSeenAt": "string",      "outcome": "open",      "outcomeAt": "string",      "outcomeBy": "string"    }  ],  "more": 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.