Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard

Request Details

Request Properties
CharacterType String

Optional character type on which to filter the leaderboard entries.

MaxResultsCount int32

Maximum number of entries to retrieve. Default 10, maximum 100.

StartPosition (required) int32

First entry in the leaderboard to be retrieved.

StatisticName (required) String

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

POST https://{{TitleID}}
    Content-Type: application/json
    X-Authentication: <user_session_ticket_value>
  "CharacterType": "blue_warrior",
  "StatisticName": "Kills",
  "StartPosition": 0,
  "MaxResultsCount": 20

Response Details

Note that the Position of the character in the results is for the overall leaderboard.

Result Properties
Leaderboard List<CharacterLeaderboardEntry>

Ordered list of leaderboard entries.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
  "code": 200,
  "status": "OK",
  "data": {
    "Leaderboard": [
        "PlayFabId": "10931252888739651331",
        "CharacterId": "9874325",
        "DisplayName": "username",
        "CharacterType": "blue_warrior",
        "StatValue": 12,
        "Position": 0



Possible Error Codes

Name Code