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.
const url = 'https://api.xovris.ai/v1/reviews/findings';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.xovris.ai/v1/reviews/findings \ --header 'Authorization: Bearer <token>'A token that can read is enough.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”Done.
object
object
object
object
object
object
object
object
object
object
object
object
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}default
Section titled “default”Any other refusal or failure. The answer says what happened and what to do next.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}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.