Skip to content

See every goal Xovris has accepted - asked, kept or started by itself - with what it proved, what it is doing and what needs a yes

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

A token that can read is enough.

Done.

Media typeapplication/json
object
accepted
required
number
verified
required
number
rate
required
One of:
number
states
required
object
accepted
required
number
verified
required
number
doneUnproved
required
number
inProgress
required
number
waitingOnPerson
required
number
blocked
required
number
falseSuccess
required
number
segments
required
object
asked
required
object
accepted
required
number
verified
required
number
doneUnproved
required
number
inProgress
required
number
waitingOnPerson
required
number
blocked
required
number
falseSuccess
required
number
selfStarted
required
object
accepted
required
number
verified
required
number
doneUnproved
required
number
inProgress
required
number
waitingOnPerson
required
number
blocked
required
number
falseSuccess
required
number
directRuns
required
object
accepted
required
number
verified
required
number
doneUnproved
required
number
inProgress
required
number
waitingOnPerson
required
number
blocked
required
number
falseSuccess
required
number
medianMinutesToVerified
required
One of:
number
oldestUnresolvedAt
required
One of:
string
unmeasured
required
Array<object>
object
figure
required
string
why
required
string
needsYes
required
Array<object>
object
id
required
string
kind
required
string
doing
required
string
at
required
string
proof
One of:
string
job
One of:
string
next
One of:
string
severity
One of:
string
press
One of:
object
label
required
string
method
required
string
path
required
string
body
object
key
additional properties
doingNow
required
Array<object>
object
id
required
string
kind
required
string
doing
required
string
at
required
string
proof
One of:
string
job
One of:
string
next
One of:
string
severity
One of:
string
press
One of:
object
label
required
string
method
required
string
path
required
string
body
object
key
additional properties
didWithProof
required
Array<object>
object
id
required
string
kind
required
string
doing
required
string
at
required
string
proof
One of:
string
job
One of:
string
next
One of:
string
severity
One of:
string
press
One of:
object
label
required
string
method
required
string
path
required
string
body
object
key
additional properties
needsYesCount
required
number
found
required
One of:
Array<object>
object
id
required
string
kind
required
string
doing
required
string
at
required
string
proof
One of:
string
job
One of:
string
next
One of:
string
severity
One of:
string
press
One of:
object
label
required
string
method
required
string
path
required
string
body
object
key
additional properties
foundOpen
required
One of:
number
spend
One of:
object
microUsd
required
number
jobs
required
number
perJobMicroUsd
required
number
unmeasuredJobs
required
number
at
required
string

Example

{  "accepted": 1,  "verified": 1,  "rate": 1,  "states": {    "accepted": 1,    "verified": 1,    "doneUnproved": 1,    "inProgress": 1,    "waitingOnPerson": 1,    "blocked": 1,    "falseSuccess": 1  },  "segments": {    "asked": {      "accepted": 1,      "verified": 1,      "doneUnproved": 1,      "inProgress": 1,      "waitingOnPerson": 1,      "blocked": 1,      "falseSuccess": 1    },    "selfStarted": {      "accepted": 1,      "verified": 1,      "doneUnproved": 1,      "inProgress": 1,      "waitingOnPerson": 1,      "blocked": 1,      "falseSuccess": 1    },    "directRuns": {      "accepted": 1,      "verified": 1,      "doneUnproved": 1,      "inProgress": 1,      "waitingOnPerson": 1,      "blocked": 1,      "falseSuccess": 1    }  },  "medianMinutesToVerified": 1,  "oldestUnresolvedAt": "string",  "unmeasured": [    {      "figure": "string",      "why": "string"    }  ],  "needsYes": [    {      "id": "string",      "kind": "string",      "doing": "string",      "at": "string",      "proof": "string",      "job": "string",      "next": "string",      "severity": "string",      "press": {        "label": "string",        "method": "string",        "path": "string",        "body": {}      }    }  ],  "doingNow": [    {      "id": "string",      "kind": "string",      "doing": "string",      "at": "string",      "proof": "string",      "job": "string",      "next": "string",      "severity": "string",      "press": {        "label": "string",        "method": "string",        "path": "string",        "body": {}      }    }  ],  "didWithProof": [    {      "id": "string",      "kind": "string",      "doing": "string",      "at": "string",      "proof": "string",      "job": "string",      "next": "string",      "severity": "string",      "press": {        "label": "string",        "method": "string",        "path": "string",        "body": {}      }    }  ],  "needsYesCount": 1,  "found": [    {      "id": "string",      "kind": "string",      "doing": "string",      "at": "string",      "proof": "string",      "job": "string",      "next": "string",      "severity": "string",      "press": {        "label": "string",        "method": "string",        "path": "string",        "body": {}      }    }  ],  "foundOpen": 1,  "spend": {    "microUsd": 1,    "jobs": 1,    "perJobMicroUsd": 1,    "unmeasuredJobs": 1  },  "at": "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.