Skip to content

Check how your web filter treats a web name, and why

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/web-filter/judge
curl --request POST \  --url https://api.xovris.ai/v1/web-filter/judge \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "domain": null, "brands": [ null ], "group": "string", "person": "string", "device": "string" }'

Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.

Media typeapplication/json
object
domain
brands
Array
group
string
person
string
device
string

Example

{  "domain": null,  "brands": [    null  ],  "group": "string",  "person": "string",  "device": "string"}

Done.

Media typeapplication/json
object
judgement
required
object
domain
required
string
unicode
required
string
registrable
required
One of:
string
categories
required
Array<string>
security
required
boolean
score
required
number
reasons
required
Array<object>
object
id
required
string
category
required
One of:
string
weight
required
number
saw
required
string
checked
required
Array<string>
dga
required
number
decision
required
object
action
required
string
Allowed values: warn block log allow
ruleId
required
One of:
string
why
required
string
page
required
One of:
object
title
required
string
message
required
string
reasons
required
Array<string>
canContinue
required
boolean
appeal
required
One of:
object
method
required
string
Allowed values: POST
path
required
string
body
required
object
domain
required
string
policyVersion
required
number
ageRead
required
boolean
listsRead
required
boolean

Example

{  "judgement": {    "domain": "string",    "unicode": "string",    "registrable": "string",    "categories": [      "string"    ],    "security": true,    "score": 1,    "reasons": [      {        "id": "string",        "category": "string",        "weight": 1,        "saw": "string"      }    ],    "checked": [      "string"    ],    "dga": 1  },  "decision": {    "action": "warn",    "ruleId": "string",    "why": "string"  },  "page": {    "title": "string",    "message": "string",    "reasons": [      "string"    ],    "canContinue": true,    "appeal": {      "method": "POST",      "path": "string",      "body": {        "domain": "string"      }    }  },  "policyVersion": 1,  "ageRead": true,  "listsRead": true}

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.