Statistics - Create Statistic Definition

Create a new entity statistic definition.

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

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. Must be less than 150 characters. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'.

Columns

StatisticColumn[]

The columns for the statistic defining the aggregation method for each column.

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

EntityType

string

The entity type allowed to have score(s) for this statistic.

VersionConfiguration

VersionConfiguration

The version reset configuration for the statistic definition.

Responses

Name Type Description
200 OK

EmptyResponse

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

CreateStatisticDefinitionRequest
EmptyResponse
ResetInterval
StatisticAggregationMethod
StatisticColumn
VersionConfiguration

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

CreateStatisticDefinitionRequest

Name Type Description
Columns

StatisticColumn[]

The columns for the statistic defining the aggregation method for each column.

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

EntityType

string

The entity type allowed to have score(s) for this statistic.

Name

string

Name of the statistic. Must be less than 150 characters. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'.

VersionConfiguration

VersionConfiguration

The version reset configuration for the statistic definition.

EmptyResponse

ResetInterval

Name Type Description
Day

string

Hour

string

Manual

string

Month

string

Week

string

StatisticAggregationMethod

Name Type Description
Last

string

Max

string

Min

string

Sum

string

StatisticColumn

Name Type Description
AggregationMethod

StatisticAggregationMethod

Aggregation method for calculating new value of a statistic.

Name

string

Name of the statistic column, as originally configured.

VersionConfiguration

Name Type Description
MaxQueryableVersions

number

The maximum number of versions of this leaderboard/statistic that can be queried.

ResetInterval

ResetInterval

Reset interval that statistics or leaderboards will reset on. When using Manual intervalthe reset can only be increased by calling the Increase version API. When using Hour interval the resetwill occur at the start of the next hour UTC time. When using Day interval the reset will occur at thestart of the next day in UTC time. When using the Week interval the reset will occur at the start ofthe next Monday in UTC time. When using Month interval the reset will occur at the start of the nextmonth in UTC time.

Error Codes

Name Code
AggregationTypeNotAllowedForMultiColumnStatistic 1590
ApiNotEnabledForTitle 1520
DuplicateColumnNameFound 1585
DuplicateStatisticName 1253
ExternalEntityNotAllowedForTier 1580
InvalidBaseTimeForInterval 1581
MaxQueryableVersionsValueNotAllowedForTier 1591
StatisticCountLimitExceeded 1203
StatisticDefinitionHasNullOrEmptyVersionConfiguration 1592
StatisticNameConflict 1196