Build a dashboard from a question
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/dashboards';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"question":null}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.xovris.ai/v1/dashboards \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "question": null }'Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.
Authorizations
Section titled “Authorizations”Request Body
Section titled “Request Body”object
Example
{ "question": null}Responses
Section titled “Responses”Done: something new was made, and the answer is it.
object
object
object
object
object
object
object
object
object
object
object
Example
{ "id": "string", "title": "string", "question": "string", "builtAt": "string", "answer": "string", "panels": [ { "id": "string", "title": "string", "source": "string", "meaning": "string", "chart": { "unit": "value", "step": 1, "asOf": "string", "x": [ 1 ], "series": [ { "id": "string", "label": "string", "values": [ 1 ] } ], "notMonitored": [ { "from": "string", "to": "string", "reason": "string" } ], "marks": [ { "kind": "open", "from": "string", "to": "string", "label": "string" } ], "perLocation": [ { "id": "string", "latest": 1, "usual": 1 } ] }, "anomaly": { "sentence": "string", "severity": "high", "cause": "string" }, "split": { "apply": "string", "variable": "location", "value": "string", "words": "string" }, "open": [ { "id": "string", "title": "string", "code": true, "incidentId": "string", "since": "string" } ], "fixed": [ { "id": "string", "title": "string", "code": true, "incidentId": "string", "fixedAt": "string", "proof": "string" } ], "counts": { "open": 1, "fixed": 1 }, "actions": { "incident": { "id": "string" }, "fix": { "label": "string", "path": "string", "body": { "packageDigest": "string" } }, "silence": { "allowed": true, "current": { "reason": "string", "until": null, "by": null } } } } ], "variables": [ { "name": "location", "label": "string", "dependsOn": "location", "value": "string", "options": [ { "value": "string", "label": "string", "count": 1 } ] } ], "view": { "query": "string", "path": "string", "asset": "string", "location": "string", "service": "string", "from": "string", "to": "string" }, "suggestedSplits": [ { "apply": "string", "variable": "location", "value": "string", "words": "string", "panelId": "string" } ], "starter": { "key": "string", "kind": "checks", "name": "string", "firstDataAt": "string" }, "waiting": [ { "id": "string", "title": "string", "meaning": "string", "why": "string" } ]}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.