Statistics - Increment Statistic Version

Service:

Progression

API Version:

241122

Increment an entity statistic definition version.

POST https://titleId.playfabapi.com/Statistic/IncrementStatisticVersion

Request Header

Name	Required	Type	Description
X-EntityToken	True	string	This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name	Required	Type	Description
Name	True	string	Name of the statistic to increment the version of.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	IncrementStatisticVersionResponse
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
IncrementStatisticVersionRequest
IncrementStatisticVersionResponse

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

IncrementStatisticVersionRequest

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Name	string	Name of the statistic to increment the version of.

IncrementStatisticVersionResponse

Name	Type	Description
Version	number	New statistic version.

Error Codes

Name	Code
StatisticNotFound	1195
StatisticUpdateInProgress	1276
StatisticVersionIncrementRateExceeded	1204