Statistics - Get Statistics For Entities

Service:

Progression

API Version:

241122

Gets statistics for the specified collection of entities.

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

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
Entities	True	EntityKey[]	Collection of Entity IDs to retrieve statistics for.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	GetStatisticsForEntitiesResponse
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
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.
EntityStatistics
EntityStatisticValue
GetStatisticsForEntitiesRequest
GetStatisticsForEntitiesResponse
StatisticAggregationMethod
StatisticColumn
StatisticColumnCollection

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

EntityStatistics

Name	Type	Description
EntityKey	EntityKey	Entity key
Statistics	EntityStatisticValue[]	All statistics for the given entitykey

EntityStatisticValue

Name	Type	Description
Metadata	string	Metadata associated with the Statistic.
Name	string	Statistic name
Scores	string[]	Statistic scores
Version	number	Statistic version

GetStatisticsForEntitiesRequest

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Entities	EntityKey[]	Collection of Entity IDs to retrieve statistics for.

GetStatisticsForEntitiesResponse

Name	Type	Description
ColumnDetails	StatisticColumnCollection	A mapping of statistic name to the columns defined in the corresponding definition.
EntitiesStatistics	EntityStatistics[]	List of entities mapped to their statistics. Only the latest version of a statistic is returned.

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.

StatisticColumnCollection

Name	Type	Description
Columns	StatisticColumn[]	Columns for the statistic defining the aggregation method for each column.

Error Codes

Name	Code
InvalidEntityType	1373
NotAuthorized	1089
StatisticNotFound	1195