Player Data Management - Get Player Statistic Versions
Retrieves the information on the available versions of the specified statistic.
POST https://titleId.playfabapi.com/Admin/GetPlayerStatisticVersionsRequest 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 | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| StatisticName |
string |
unique name of the statistic |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
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. |
|
| 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 |
|
Get |
|
|
Get |
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. |
|
Player |
|
|
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 |
GetPlayerStatisticVersionsRequest
| Name | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| StatisticName |
string |
unique name of the statistic |
GetPlayerStatisticVersionsResult
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.
| Name | Type | Description |
|---|---|---|
| StatisticVersions |
version change history of the statistic |
PlayerStatisticVersion
| Name | Type | Description |
|---|---|---|
| ActivationTime |
string |
time when the statistic version became active |
| ArchiveDownloadUrl |
string |
URL for the downloadable archive of player statistic values, if available |
| DeactivationTime |
string |
time when the statistic version became inactive due to statistic version incrementing |
| ScheduledActivationTime |
string |
time at which the statistic version was scheduled to become active, based on the configured ResetInterval |
| ScheduledDeactivationTime |
string |
time at which the statistic version was scheduled to become inactive, based on the configured ResetInterval |
| StatisticName |
string |
name of the statistic when the version became active |
| Status |
status of the statistic version |
|
| Version |
number |
version of the statistic |
StatisticVersionStatus
| Name | Type | Description |
|---|---|---|
| Active |
string |
|
| ArchivalPending |
string |
|
| Archived |
string |
|
| Snapshot |
string |
|
| SnapshotPending |
string |
Error Codes
| Name | Code |
|---|---|
| StatisticNotFound | 1195 |