Documentation

GetPlayerStatisticVersions

Retrieves the information on the available versions of the specified statistic.

Request Details

GetPlayerStatisticVersionsRequest
Request Properties
StatisticName String

unique name of the statistic

POST https://{{TitleID}}.playfabapi.com/Admin/GetPlayerStatisticVersions
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "StatisticName": "headshots"
}
        

Response Details

Statistics are numeric values, with each statistic in the title also generating a leaderboard. The information returned in the results defines the state of a specific version of a statistic, including when it was or will become the currently active version, when it will (or did) become a previous version, and its archival state if it is no longer the active version. For a statistic which has been reset, once the archival status is Complete, the full set of statistics for all players in the leaderboard for that version may be retrieved via the ArchiveDownloadUrl. Statistics which have not been reset (incremented/versioned) will only have a single version which is not scheduled to reset.

GetPlayerStatisticVersionsResult
Result Properties
StatisticVersions List<PlayerStatisticVersion>

version change history of the statistic

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "StatisticVersions": [
      {
        "StatisticName": "headshots",
        "Version": 2,
        "ActivationTime": "2016-12-05T10:02:01Z",
        "ArchivalStatus": "NotScheduled",
        "Status": "Archived",
        "ArchiveDownloadUrl": "https://Someurl"
      }
    ]
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code
StatisticNotFound 1195