Query Highscores

get https://neon-loyalty-qa.spika.com/loyalty/v1/{space}/games/{gameLookupId}/highscores

Returns the highest scores achieved, sorted with the top score first

Path Params

space

string

required

The name of the space (database) assigned to you.

gameLookupId

string

required

One of:

The Entity's internal Entity Id
The Entity's name
The Entity's business Id, prefixed with $

Query Params

oncePerMember

boolean

Defaults to false

If true, only count's each Member's highest score, meaning each Member can only appear once in

includeUnfinished

int32

If true, includes plays that have not been marked as FINISHED. This allows the highscore list to be updated during ongoing game plays.

reversedList

int32

If true, reverses the board so the Member who is last appears at the top.

listSize

int32

Defaults to 10

The number of entries to return.

dim

string

The Dimensions under which the calling application operates.
Format: {dim1}:{value1}[;{dim2}:{value2}[;...]]

bypassDimensionGate

boolean

If true, returns resources even if the Entity's Dimension filter doesn't match the passed in Dimensions.
Default is false.

includeUnpublished

boolean

If true, also exposes Installed but Unpublished entity resources. Default is false.

Response

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://neon-loyalty-qa.spika.com/loyalty/v1/space/games/gameLookupId/highscores?oncePerMember=false&listSize=10' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK