Get Leaderboard
Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| LeaderboardVersionNotAvailable | 1277 |
| ProductDisabledForTitle | 1609 |
Authorizations
This API requires a title secret key, available to title admins, from PlayFab Game Manager.
Body
Maximum number of entries to retrieve.
First entry in the leaderboard to be retrieved.
Unique identifier for the title-specific statistic for the leaderboard.
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client, only the allowed client profile properties for the title may be requested. These allowed properties are configured in the Game Manager "Client Profile Options" tab in the "Settings" section.
If set to false, Version is considered null. If true, uses the specified Version
The version of the leaderboard to get.
Response
Note that the Position of the user in the results is for the overall leaderboard.
