Skip to content

Replay, masking, consent, limits and retention for each platform

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/rum/platforms
curl --request GET \  --url https://api.xovris.ai/v1/rum/platforms \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

Done.

Media typeapplication/json
object
platforms
required
Array
One of:
object
retentionDays
required
number
replayRetentionDays
required
number
platform
required
string
Allowed values: web
sdk
required
string
signals
required
Array
replay
required
string
maskingDefault
required
string
consent
required
string
captureLimits
required
string
fixture
required
string
hundred
required
object
signals
required
object
measure
required
string
target
required
number
Allowed values: 1
maskingLeaks
required
object
measure
required
string
target
required
number
Allowed values: 0
brokenScreen
required
object
measure
required
string
target
required
number
Allowed values: 1
feedback
required
object
measure
required
string
crossUserExposure
required
number
Allowed values: 0
clientFaults
required
object
measure
required
string
target
required
number
Allowed values: 1
libraryLeaks
required
object
measure
required
string
target
required
number
Allowed values: 0
replays
required
object
plan
required
string
perMonth
required
number
used
required
number
retention
required
object
plan
required
string
kept
required
object
sessionDays
required
number
replayDays
required
number
ladder
required
Array<object>
object
plan
required
string
sessionDays
required
number
replayDays
required
number
extraMonth
required
object
per10kSessions
required
object
costUsd
required
number
priceUsd
required
number
margin
required
number
per1kReplays
required
object
costUsd
required
number
priceUsd
required
number
margin
required
number

Example

{  "platforms": [    {      "retentionDays": 1,      "replayRetentionDays": 1,      "platform": "web",      "sdk": "string",      "signals": [        "navigation"      ],      "replay": "string",      "maskingDefault": "string",      "consent": "string",      "captureLimits": "string",      "fixture": "string"    }  ],  "hundred": {    "signals": {      "measure": "string",      "target": 1    },    "maskingLeaks": {      "measure": "string",      "target": 0    },    "brokenScreen": {      "measure": "string",      "target": 1    },    "feedback": {      "measure": "string",      "crossUserExposure": 0    },    "clientFaults": {      "measure": "string",      "target": 1    },    "libraryLeaks": {      "measure": "string",      "target": 0    }  },  "replays": {    "plan": "string",    "perMonth": 1,    "used": 1  },  "retention": {    "plan": "string",    "kept": {      "sessionDays": 1,      "replayDays": 1    },    "ladder": [      {        "plan": "string",        "sessionDays": 1,        "replayDays": 1,        "extraMonth": {          "per10kSessions": {            "costUsd": 1,            "priceUsd": 1,            "margin": 1          },          "per1kReplays": {            "costUsd": 1,            "priceUsd": 1,            "margin": 1          }        }      }    ]  }}

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.