List the alerts raised in your workspace
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/alerts';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/alerts \ --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
object
object
Example
{ "now": "string", "channels": [ { "channelId": "string", "kind": "push", "label": "string", "health": "string", "reason": "string", "since": "string", "last24h": { "accepted": 1, "delivered": 1, "failed": 1, "bounced": 1, "queued": 1, "held": 1 }, "lastDelivery": { "at": "string", "state": "string", "answeredMs": 1, "deliveredAfterMs": 1 }, "target": "string", "workspace": "string", "paused": true } ], "paths": [ { "path": "string", "state": "string", "since": "string", "reason": "string" } ], "killSwitches": [ { "scope": "string", "reason": "string", "since": "string" } ], "tests": [ { "id": "string", "channel": "email", "state": "failed", "requestedAt": "string", "providerReportedAt": "string", "providerReference": "string", "failure": { "code": "string", "message": "string" }, "fallbackOf": "string", "testId": "string", "channelId": "string", "channelLabel": "string", "attempts": 1, "delay": { "type": "string", "at": "string", "until": "string", "recipients": [ { "address": "string", "status": null, "diagnostic": null } ], "provider": "string" } } ], "recent": [ { "notificationId": "string", "incidentId": "string", "alertId": "string", "kind": "string", "severity": "string", "channel": "push", "recipient": "string", "state": "string", "label": "string", "createdAt": "string", "acceptedAt": "string", "deliveredAt": "string", "acknowledgedAt": "string", "reroutedFrom": "string", "awaitingReport": true, "delay": { "type": "string", "at": "string", "until": "string", "recipients": [ { "address": "string", "status": null, "diagnostic": null } ], "provider": "string" }, "attempts": [ { "no": 1, "state": "string", "provider": "string", "providerMessageId": "string", "code": "string", "startedAt": "string", "acceptedAt": "string", "deliveredAt": "string", "failedAt": "string" } ], "why": "string", "next": "string", "fix": { "label": "string", "method": "POST", "path": "string" } } ], "builtInEmail": { "added": true, "suggested": "string" }, "timings": { "holds": [ { "minutes": 1, "said": "string" } ], "repeat": { "times": 1, "afterMinutes": 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.