Player Data Management - Get Player Statistic Versions

  • Reference
Service:
Server
API Version:
240426

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

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

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 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

GetPlayerStatisticVersionsResult

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
GetPlayerStatisticVersionsRequest
GetPlayerStatisticVersionsResult
PlayerStatisticVersion

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

Name Type Description
StatisticVersions

PlayerStatisticVersion[]

version change history of the statistic

PlayerStatisticVersion

Name Type Description
ActivationTime

string

time when the statistic version became active
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
Version

number

version of the statistic

Error Codes

Name Code
StatisticNotFound 1195