Skip to content

Narrow the code review findings on every axis at once, with a count on every value

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

A token that can read is enough.

Done.

Media typeapplication/json
object
view
required
One of:
object
id
required
string
name
required
string
query
required
object
severity
Array<string>
category
Array<string>
kind
Array<string>
effort
Array<string>
status
Array<string>
source
Array<string>
file
string
createdAt
required
string
days
required
number
repository
required
One of:
string
query
required
object
severity
Array<string>
category
Array<string>
kind
Array<string>
effort
Array<string>
status
Array<string>
source
Array<string>
file
string
total
required
number
counts
required
object
kind
required
object
key
additional properties
number
status
required
object
key
additional properties
number
file
required
object
key
additional properties
number
source
required
object
key
additional properties
number
severity
required
object
key
additional properties
number
category
required
object
key
additional properties
number
effort
required
object
key
additional properties
number
notice
required
string
findings
required
Array<object>
object
effort
required
One of:
string
Allowed values: small fix-ready larger
standards
required
One of:
object
cwe
required
string
owasp
required
One of:
string
top25
required
One of:
number
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

{  "view": {    "id": "string",    "name": "string",    "query": {      "severity": [        "string"      ],      "category": [        "string"      ],      "kind": [        "string"      ],      "effort": [        "string"      ],      "status": [        "string"      ],      "source": [        "string"      ],      "file": "string"    },    "createdAt": "string"  },  "days": 1,  "repository": "string",  "query": {    "severity": [      "string"    ],    "category": [      "string"    ],    "kind": [      "string"    ],    "effort": [      "string"    ],    "status": [      "string"    ],    "source": [      "string"    ],    "file": "string"  },  "total": 1,  "counts": {    "kind": {},    "status": {},    "file": {},    "source": {},    "severity": {},    "category": {},    "effort": {}  },  "notice": "string",  "findings": [    {      "effort": "small",      "standards": {        "cwe": "string",        "owasp": "string",        "top25": 1      },      "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.