Characters - Get Character Statistics
Retrieves the details of all title-specific statistics for the specific character
POST https://titleId.playfabapi.com/Server/GetCharacterStatisticsRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-SecretKey | True |
string |
This API requires a title secret key, available to title admins, from PlayFab Game Manager. |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| CharacterId | True |
string |
Unique PlayFab assigned ID for a specific character owned by a user |
| PlayFabId | True |
string |
Unique PlayFab assigned ID of the user on whom the operation will be performed. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-SecretKey
This API requires a title secret key, available to title admins, from PlayFab Game Manager.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Get |
Character statistics are similar to user statistics in that they are numeric values which may only be updated by a server operation, in order to minimize the opportunity for unauthorized changes. In addition to being available for use by the title, the statistics are used for all leaderboard operations in PlayFab. |
|
Get |
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
Character statistics are similar to user statistics in that they are numeric values which may only be updated by a server operation, in order to minimize the opportunity for unauthorized changes. In addition to being available for use by the title, the statistics are used for all leaderboard operations in PlayFab.
| Name | Type | Description |
|---|---|---|
| CharacterId |
string |
Unique PlayFab assigned ID for a specific character owned by a user |
| PlayFabId |
string |
Unique PlayFab assigned ID of the user on whom the operation will be performed. |
GetCharacterStatisticsResult
| Name | Type | Description |
|---|---|---|
| CharacterId |
string |
Unique identifier of the character for the statistics. |
| CharacterStatistics |
object |
Character statistics for the requested user. |
| PlayFabId |
string |
PlayFab unique identifier of the user whose character statistics are being returned. |
Error Codes
| Name | Code |
|---|---|
| CharacterNotFound | 1135 |