Characters - Get Character Leaderboard
Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard
POST https://titleId.playfabapi.com/Server/GetCharacterLeaderboardRequest 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 |
|---|---|---|---|
| MaxResultsCount | True |
number |
Maximum number of entries to retrieve. |
| StartPosition | True |
number |
First entry in the leaderboard to be retrieved. |
| StatisticName | True |
string |
Unique identifier for the title-specific statistic for the leaderboard. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
Note that the Position of the character in the results is for the overall leaderboard. |
|
| 400 Bad Request |
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 |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Character |
|
|
Get |
|
|
Get |
Note that the Position of the character in the results is for the overall leaderboard. |
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. |
GetCharacterLeaderboardRequest
| Name | Type | Description |
|---|---|---|
| MaxResultsCount |
number |
Maximum number of entries to retrieve. |
| StartPosition |
number |
First entry in the leaderboard to be retrieved. |
| StatisticName |
string |
Unique identifier for the title-specific statistic for the leaderboard. |
GetCharacterLeaderboardResult
Note that the Position of the character in the results is for the overall leaderboard.
| Name | Type | Description |
|---|---|---|
| Leaderboard |
Ordered list of leaderboard entries. |