Statistics - Delete Statistics

Service:

Progression

API Version:

241122

Delete statistics on an entity profile. This will remove all rankings from associated leaderboards.

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

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
Statistics	True	StatisticDelete[]	Collection of statistics to remove from this entity.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Entity		EntityKey	The optional entity to perform this action on. Defaults to the currently logged in entity.

Responses

Name	Type	Description
200 OK	DeleteStatisticsResponse
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
DeleteStatisticsRequest
DeleteStatisticsResponse
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.
StatisticDelete

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

DeleteStatisticsRequest

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Entity	EntityKey	The optional entity to perform this action on. Defaults to the currently logged in entity.
Statistics	StatisticDelete[]	Collection of statistics to remove from this entity.

DeleteStatisticsResponse

Name	Type	Description
Entity	EntityKey	The entity id and type.

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

StatisticDelete

Name	Type	Description
Name	string	Name of the statistic, as originally configured.