Get Member Rank - Game API

Get the rank and score information for the specified leaderboard member on the specified leaderboard

{ "member_id": "1", "rank": 3, "score": 3004, "player": { "id": 1, "public_uid": "TSEYDXD8", "name": "Player Name", "ulid": "01HRPTCW34M1DHQP20KY3EWJ6F" }, "metadata": "some metadata" }

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 member rank on

Example:

member_id

string

required

The id of the member you want to get member rank for on the specified leaderboard

Example:

686

Header Params

x-session-token

string

required

Example:

Responses

🟢200Success

application/json

Body

Response object holding member rank information

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)

integer

required

The id of the player

public_uid

string

required

The public uid of the player

name

string | null

required

The name of the player (if any has been set)

ulid

string

required

The ulid of the player

metadata

string | null

required

Metadata of this leaderboard entry (if any)