Get Leaderboard Around Player
Retrieves a list of ranked users for the given statistic, centered on the requested player. If PlayFabId is empty or null will return currently logged in user.
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| LeaderboardVersionNotAvailable | 1277 |
| ProductDisabledForTitle | 1609 |
Authorizations
This API requires a client session ticket, available from any Client Login function.
Body
Statistic used to rank players for this leaderboard.
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Maximum number of entries to retrieve. Default 10, maximum 100.
PlayFab unique identifier of the user to center the leaderboard around. If null will center on the logged in user.
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: When calling 'GetLeaderboardAround...' APIs, the position of the user defaults to 0 when the user does not have the corresponding statistic.
The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.
The Http status code as a string.
Note: When calling 'GetLeaderboardAround...' APIs, the position of the user defaults to 0 when the user does not have the corresponding statistic.
