v1

latestOpenAPI 3.0.12026-07-24210349345.4 KB
Leaderboard Statistics

Player's Current Rank

Returns the player's current rank and score on a leaderboard. Returns null if the player has no recorded position.

get/leaderboard-statistics/brand/{brandId}/leaderboard/{leaderboardId}/player/{playerId}

Path parameters

brandIdstring uuid required
Example:aebb6a6a-bdef-480f-8096-e13f9c3d4969

Brand UUID returned by GET /brands/default/{tenantId}.

leaderboardIdstring required
Example:lb-11111111-1111-1111-1111-111111111111

Leaderboard UUID (from the leaderboards list id).

playerIdstring required
Example:player-123

Your internal player/customer identifier.

Response

The player's rank and score, or null.

playerIdstring
playerNamestring nullable

Display name at the time of last score update. null if not set.

rankinteger

Player's current position (1 = first place).

scoreinteger

Player's accumulated score on this leaderboard.