Home > @world-wide-lab/client > Client > getLeaderboardScores

Client.getLeaderboardScores() method

Get the scores of a leaderboard.

Signature:

getLeaderboardScores(leaderboardId: string, level?: "individual" | "groups", options?: GetLeaderoardScoresOptions): Promise<{
        scores: LeaderboardScores;
    }>;

Parameters

Parameter	Type	Description
leaderboardId	string	The id of the leaderboard to get scores from
level	"individual" | "groups"	(Optional) The level of scores to get: individual or groups
options	GetLeaderoardScoresOptions	(Optional) Specify what scores to get, e.g. sorting and aggregation

**Returns:**

Promise<{ scores: LeaderboardScores; }>

The scores of the leaderboard