Get Score List - Game API

Get a list of entries from the specified leaderboard

{ "pagination": { "previous_cursor": null, "total": 100, "next_cursor": 2 }, "items": [ { "player": { "name": "earum vel voluptas", "public_uid": "Excepteur", "id": 123, "ulid": "pariatur ipsum in" }, "metadata": "ea commodo", "member_id": "Duis dolor nostrud deserunt", "rank": 87411863, "score": 12029034 } ] }

Request

Authorization

API Key

Add parameter in header

x-session-token

Example:

x-session-token: ********************

Path Params

leaderboard_id

string

required

The leaderboard key OR integer id of the leaderboard you wish to retreive scores for

Example:

Query Params

count

string

required

How many leaderboard entries to retreive in this request

Example:

200

after

string

optional

Used when making subsequent requests to get count number of elements starting from number after

Example:

Header Params

x-session-token

string

required

Example:

Responses

🟢200OK

application/json

Body

Response object containing leaderboard entries

pagination

object

required

Pagination data for this request

previous_cursor

integer | null

required

A cursor pointing to the previous page according to the current page size (count) and cursor (after)

total

integer

required

The total number of elements available to paginate through

next_cursor

integer

required

A cursor pointing to the next page according to the current page size (count) and cursor (after)

items

array [object {5}]

required

List of leaderboard member information (rank, score, etc.)

member_id

string

required

The id of the member

rank

integer

required

The rank that this member holds on the specified leaderboard

score

integer

required

The score for this rank and member

player

object | null

optional

Information about the player relating to this leaderboard entry (if leaderboard is of type player)

metadata

string | null

required

Metadata of this leaderboard entry (if any)