Skip to content

Read a dashboard

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

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
One of:
One of:
object
id
required
string
title
required
string
question
required
One of:
string
builtAt
required
string
answer
required
string
panels
required
Array<object>
object
id
required
string
title
required
string
source
required
string
meaning
required
One of:
string
chart
required
object
unit
required
string
Allowed values: value count percent ms
step
required
number
asOf
required
string
x
required
Array<number>
series
required
Array<object>
object
id
required
string
label
required
string
values
required
Array
notMonitored
Array<object>
object
from
required
string
to
required
string
reason
string
marks
Array<object>
object
kind
required
string
Allowed values: open fixed
from
required
string
to
required
string
label
required
string
perLocation
Array<object>
object
id
required
string
latest
required
One of:
number
usual
required
One of:
number
anomaly
required
One of:
object
sentence
required
string
severity
required
string
Allowed values: high medium low critical
cause
required
One of:
string
split
required
One of:
object
apply
required
string
variable
required
string
Allowed values: location asset service
value
required
string
words
required
string
open
required
Array<object>
object
id
required
string
title
required
string
code
required
boolean
incidentId
required
string
since
required
string
fixed
required
Array<object>
object
id
required
string
title
required
string
code
required
boolean
incidentId
required
string
fixedAt
required
string
proof
required
string
counts
required
object
open
required
number
fixed
required
number
actions
required
One of:
object
incident
required
One of:
object
id
required
string
fix
required
One of:
object
label
required
string
path
required
string
body
required
object
packageDigest
required
string
silence
required
object
allowed
required
boolean
current
required
One of:
object
reason
required
string
until
required
One of:
string
by
required
One of:
string
variables
required
Array<object>
object
name
required
string
Allowed values: location asset service
label
required
string
dependsOn
required
One of:
string
Allowed values: location asset service
value
required
One of:
string
options
required
Array<object>
object
value
required
string
label
required
string
count
required
One of:
number
view
required
object
query
required
string
path
required
string
asset
required
One of:
string
location
required
One of:
string
service
required
One of:
string
from
required
One of:
string
to
required
One of:
string
suggestedSplits
required
Array<object>
object
apply
required
string
variable
required
string
Allowed values: location asset service
value
required
string
words
required
string
panelId
required
string
starter
required
One of:
object
key
required
string
kind
required
string
Allowed values: checks logs errors metrics
name
required
string
firstDataAt
required
string
waiting
required
Array<object>
object
id
required
string
title
required
string
meaning
required
One of:
string
why
required
string

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": [              null            ]          }        ],        "notMonitored": [          {            "from": "string",            "to": "string",            "reason": "string"          }        ],        "marks": [          {            "kind": "open",            "from": "string",            "to": "string",            "label": "string"          }        ],        "perLocation": [          {            "id": "string",            "latest": null,            "usual": null          }        ]      },      "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": null        },        "fix": {          "label": null,          "path": null,          "body": null        },        "silence": {          "allowed": true,          "current": 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.

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.