Characters - Get Leaderboard Around Character

Service:

Server

API Version:

241122

Retrieves a list of ranked characters for the given statistic, centered on the requested user

POST https://titleId.playfabapi.com/Server/GetLeaderboardAroundCharacter

Request Header

Name	Required	Type	Description
X-SecretKey	True	string	This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Request Body

Name	Required	Type	Description
CharacterId	True	string	Unique PlayFab assigned ID for a specific character owned by a user
MaxResultsCount	True	number	Maximum number of entries to retrieve.
PlayFabId	True	string	Unique PlayFab assigned ID of the user on whom the operation will be performed.
StatisticName	True	string	Unique identifier for the title-specific statistic for the leaderboard.

Responses

Name	Type	Description
200 OK	GetLeaderboardAroundCharacterResult	Note: When calling 'GetLeaderboardAround...' APIs, the position of the character defaults to 0 when the character does not have the corresponding statistic.
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-SecretKey

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

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
CharacterLeaderboardEntry
GetLeaderboardAroundCharacterRequest
GetLeaderboardAroundCharacterResult	Note: When calling 'GetLeaderboardAround...' APIs, the position of the character defaults to 0 when the character does not have the corresponding statistic.

ApiErrorWrapper

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

CharacterLeaderboardEntry

Name	Type	Description
CharacterId	string	PlayFab unique identifier of the character that belongs to the user for this leaderboard entry.
CharacterName	string	Title-specific display name of the character for this leaderboard entry.
CharacterType	string	Name of the character class for this entry.
DisplayName	string	Title-specific display name of the user for this leaderboard entry.
PlayFabId	string	PlayFab unique identifier of the user for this leaderboard entry.
Position	number	User's overall position in the leaderboard.
StatValue	number	Specific value of the user's statistic.

GetLeaderboardAroundCharacterRequest

Name	Type	Description
CharacterId	string	Unique PlayFab assigned ID for a specific character owned by a user
MaxResultsCount	number	Maximum number of entries to retrieve.
PlayFabId	string	Unique PlayFab assigned ID of the user on whom the operation will be performed.
StatisticName	string	Unique identifier for the title-specific statistic for the leaderboard.

GetLeaderboardAroundCharacterResult

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

Name	Type	Description
Leaderboard	CharacterLeaderboardEntry[]	Ordered list of leaderboard entries.