Skip to main content
POST
Get Leaderboard Around Character

Authorizations

X-SecretKey
string
header
required

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Body

application/json
CharacterId
string
required

Unique PlayFab assigned ID for a specific character owned by a user

MaxResultsCount
number
required

Maximum number of entries to retrieve.

PlayFabId
string
required

Unique PlayFab assigned ID of the user on whom the operation will be performed.

StatisticName
string
required

Unique identifier for the title-specific statistic for the leaderboard.

Response

Note: When calling 'GetLeaderboardAround...' APIs, the position of the character defaults to 0 when the character does not have the corresponding statistic.

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object

Note: When calling 'GetLeaderboardAround...' APIs, the position of the character defaults to 0 when the character does not have the corresponding statistic.

Example:
Last modified on October 1, 2026