Statistics - Get Statistic Definition
Get current statistic definition information
POST https://titleId.playfabapi.com/Statistic/GetStatisticDefinitionRequest 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. |
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
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 |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Get |
|
|
Get |
|
|
Reset |
|
|
Statistic |
|
|
Statistic |
|
|
Version |
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 |
GetStatisticDefinitionRequest
| 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. Must be less than 150 characters. |
GetStatisticDefinitionResponse
| Name | Type | Description |
|---|---|---|
| Columns |
The columns for the statistic defining the aggregation method for each column. |
|
| Created |
string |
Created time, in UTC |
| EntityType |
string |
The entity type that can have this statistic. |
| LastResetTime |
string |
Last time, in UTC, statistic version was incremented. |
| LinkedLeaderboardNames |
string[] |
The list of leaderboards that are linked to this statistic definition. |
| Name |
string |
Name of the statistic. |
| Version |
number |
Statistic version. |
| VersionConfiguration |
The version reset configuration for the leaderboard definition. |
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 |
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 |
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 |
|---|---|
| StatisticNotFound | 1195 |