v1

latestOpenAPI 3.0.12026-07-24210349345.4 KB
Leaderboard Statistics

Top Players on a Leaderboard

Returns the top players ordered by score descending. The response has no rank field. Derive rank from the array position (index + 1).

get/leaderboard-statistics/brand/{brandId}/leaderboard/{leaderboardId}/top

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

limitinteger

Number of players to return. Range 1 to 100. Default 100.

Response

Top players, sorted by score descending.

playerIdstring
playerNamestring nullable

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

scoreinteger

Player's accumulated score on this leaderboard.