Statistics - Delete Statistic Definition

Delete an entity statistic definition. Will delete all statistics on entity profiles and leaderboards.

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

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 to delete.

CustomTags

object

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

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

DeleteStatisticDefinitionRequest
EmptyResponse

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

DeleteStatisticDefinitionRequest

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 to delete.

EmptyResponse

Error Codes

Name Code
StatisticDefinitionModificationNotAllowedWhileLinked 1577
StatisticNotFound 1195
StatisticUpdateInProgress 1276