Skip to content

An audience added to a private status page - its name, the parts it reads, and its own password, networks or both

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.

POST
/v1/status-pages/{id}/audiences
curl --request POST \  --url https://api.xovris.ai/v1/status-pages/example/audiences \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "name": null, "parts": null, "password": null, "networks": 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.

id
required
string
Media typeapplication/json
object
name
parts
password
networks

Example

{  "name": null,  "parts": null,  "password": null,  "networks": null}

Done.

Media typeapplication/json
object
ok
required
boolean
audience
required
object
id
required
string
name
required
string
parts
required
Array<string>
password
required
boolean
passwordSetAt
required
One of:
string
networks
required
Array<string>
followers
required
number

Example

{  "ok": true,  "audience": {    "id": "string",    "name": "string",    "parts": [      "string"    ],    "password": true,    "passwordSetAt": "string",    "networks": [      "string"    ],    "followers": 1  }}

Done: something new was made, and the answer is it.

Media typeapplication/json
object
ok
required
boolean
audience
required
object
id
required
string
name
required
string
parts
required
Array<string>
password
required
boolean
passwordSetAt
required
One of:
string
networks
required
Array<string>
followers
required
number

Example

{  "ok": true,  "audience": {    "id": "string",    "name": "string",    "parts": [      "string"    ],    "password": true,    "passwordSetAt": "string",    "networks": [      "string"    ],    "followers": 1  }}

Started: the answer says where to follow it.

Media typeapplication/json
object

Example generated

{}

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.