Sign in

v1

latestOpenAPI 3.0.12026-07-24210349345.4 KB
Leaderboard Statistics

Players in a Rank Range

Returns players in the given inclusive rank range. Use for pagination, or to show "players around me".

get/leaderboard-statistics/brand/{brandId}/leaderboard/{leaderboardId}/rank-range

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).

Query parameters

rankFrominteger required
Example:1

Start rank (inclusive). Minimum 1.

rankTointeger required
Example:20

End rank (inclusive). Minimum 1.

Response

Ranked players in the requested range.

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.