Statistics - Get Statistics
Gets statistics for the specified entity.
Allowed entity token types: title, title_player_account, game_server
POST https://titleId.playfabapi.com/Statistic/GetStatisticsRequest 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 | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| Entity |
The optional entity to perform this action on. Defaults to the currently logged in entity. |
|
| StatisticNames |
string[] |
The list of statistics to return for the user. If set to null, the current version of all statistics are returned. |
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 |
|
Entity |
Combined entity type and ID structure which uniquely identifies a single entity. |
|
Entity |
|
|
Get |
|
|
Get |
|
|
Statistic |
|
|
Statistic |
|
|
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 |
EntityKey
Combined entity type and ID structure which uniquely identifies a single entity.
| Name | Type | Description |
|---|---|---|
| Id |
string |
Unique ID of the entity. |
| Type |
string |
Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types |
EntityStatisticValue
| Name | Type | Description |
|---|---|---|
| Metadata |
string |
Metadata associated with the Statistic. |
| Name |
string |
Statistic name |
| Scores |
string[] |
Statistic scores |
| Version |
number |
Statistic version |
GetStatisticsRequest
| Name | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| Entity |
The optional entity to perform this action on. Defaults to the currently logged in entity. |
|
| StatisticNames |
string[] |
The list of statistics to return for the user. If set to null, the current version of all statistics are returned. |
GetStatisticsResponse
| Name | Type | Description |
|---|---|---|
| ColumnDetails |
A mapping of statistic name to the columns defined in the corresponding definition. |
|
| Entity |
The entity id and type. |
|
| Statistics |
List of statistics keyed by Name. Only the latest version of a statistic is returned. |
StatisticAggregationMethod
| Value | Description |
|---|---|
| Last | |
| Min | |
| Max | |
| Sum |
StatisticColumn
| Name | Type | Description |
|---|---|---|
| AggregationMethod |
Aggregation method for calculating new value of a statistic. |
|
| Name |
string |
Name of the statistic column, as originally configured. |
StatisticColumnCollection
| Name | Type | Description |
|---|---|---|
| Columns |
Columns for the statistic defining the aggregation method for each column. |
Error Codes
| Name | Code |
|---|---|
| APINotEnabledForGameClientAccess | 1082 |
| InvalidEntityType | 1373 |
| NotAuthorized | 1089 |
| StatisticNotFound | 1195 |