Share via


Characters - Get Character Statistics

Retrieves the details of all title-specific statistics for the user

POST https://titleId.playfabapi.com/Client/GetCharacterStatistics

Request Header

Name Required Type Description
X-Authorization True

string

This API requires a client session ticket, available from any Client Login function.

Request Body

Name Required Type Description
CharacterId True

string

Unique PlayFab assigned ID for a specific character owned by a user

Responses

Name Type Description
200 OK

GetCharacterStatisticsResult

In addition to being available for use by the title, the statistics are used for all leaderboard operations in PlayFab.

400 Bad Request

ApiErrorWrapper

This is the outer wrapper for all responses with errors

Security

X-Authorization

This API requires a client session ticket, available from any Client Login function.

Type: apiKey
In: header

Definitions

Name Description
ApiErrorWrapper

The basic wrapper around every failed API response

GetCharacterStatisticsRequest
GetCharacterStatisticsResult

In addition to being available for use by the title, the statistics are used for all leaderboard operations in PlayFab.

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

GetCharacterStatisticsRequest

Name Type Description
CharacterId

string

Unique PlayFab assigned ID for a specific character owned by a user

GetCharacterStatisticsResult

In addition to being available for use by the title, the statistics are used for all leaderboard operations in PlayFab.

Name Type Description
CharacterStatistics

object

The requested character statistics.

Error Codes

Name Code
CharacterNotFound 1135