Get Statistics
Gets statistics for the specified entity.
Allowed entity token types: title, title_player_account, game_server
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| APINotEnabledForGameClientAccess | 1082 |
| InvalidEntityType | 1373 |
| NotAuthorized | 1089 |
| StatisticNotFound | 1195 |
curl --request POST \
--url https://{titleId}.playfabapi.com/Statistic/GetStatistics \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"StatisticNames": [
"SpeedRuns",
"Boosts"
],
"Entity": {
"Id": "A197412JDA",
"Type": "title_player_account",
"TypeString": "title_player_account"
}
}
'import requests
url = "https://{titleId}.playfabapi.com/Statistic/GetStatistics"
payload = {
"StatisticNames": ["SpeedRuns", "Boosts"],
"Entity": {
"Id": "A197412JDA",
"Type": "title_player_account",
"TypeString": "title_player_account"
}
}
headers = {
"X-EntityToken": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
StatisticNames: ['SpeedRuns', 'Boosts'],
Entity: {
Id: 'A197412JDA',
Type: 'title_player_account',
TypeString: 'title_player_account'
}
})
};
fetch('https://{titleId}.playfabapi.com/Statistic/GetStatistics', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{titleId}.playfabapi.com/Statistic/GetStatistics",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'StatisticNames' => [
'SpeedRuns',
'Boosts'
],
'Entity' => [
'Id' => 'A197412JDA',
'Type' => 'title_player_account',
'TypeString' => 'title_player_account'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-EntityToken: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{titleId}.playfabapi.com/Statistic/GetStatistics"
payload := strings.NewReader("{\n \"StatisticNames\": [\n \"SpeedRuns\",\n \"Boosts\"\n ],\n \"Entity\": {\n \"Id\": \"A197412JDA\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-EntityToken", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Statistic/GetStatistics")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"StatisticNames\": [\n \"SpeedRuns\",\n \"Boosts\"\n ],\n \"Entity\": {\n \"Id\": \"A197412JDA\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Statistic/GetStatistics")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"StatisticNames\": [\n \"SpeedRuns\",\n \"Boosts\"\n ],\n \"Entity\": {\n \"Id\": \"A197412JDA\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"Statistics": {
"SpeedRuns": {
"Name": "SpeedRuns",
"Scores": [
"89"
]
}
},
"Entity": {
"Id": "184131840178",
"Type": "title_player_account",
"TypeString": "title_player_account"
}
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}Authorizations
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Body
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
The optional entity to perform this action on. Defaults to the currently logged in entity.
Show child attributes
Show child attributes
The list of statistics to return for the user. If set to null, the current version of all statistics are returned.
Response
The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.
The Http status code as a string.
Show child attributes
Show child attributes
{
"Statistics": {
"SpeedRuns": { "Name": "SpeedRuns", "Scores": ["89"] }
},
"Entity": {
"Id": "184131840178",
"Type": "title_player_account",
"TypeString": "title_player_account"
}
}
Was this page helpful?
curl --request POST \
--url https://{titleId}.playfabapi.com/Statistic/GetStatistics \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"StatisticNames": [
"SpeedRuns",
"Boosts"
],
"Entity": {
"Id": "A197412JDA",
"Type": "title_player_account",
"TypeString": "title_player_account"
}
}
'import requests
url = "https://{titleId}.playfabapi.com/Statistic/GetStatistics"
payload = {
"StatisticNames": ["SpeedRuns", "Boosts"],
"Entity": {
"Id": "A197412JDA",
"Type": "title_player_account",
"TypeString": "title_player_account"
}
}
headers = {
"X-EntityToken": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
StatisticNames: ['SpeedRuns', 'Boosts'],
Entity: {
Id: 'A197412JDA',
Type: 'title_player_account',
TypeString: 'title_player_account'
}
})
};
fetch('https://{titleId}.playfabapi.com/Statistic/GetStatistics', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{titleId}.playfabapi.com/Statistic/GetStatistics",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'StatisticNames' => [
'SpeedRuns',
'Boosts'
],
'Entity' => [
'Id' => 'A197412JDA',
'Type' => 'title_player_account',
'TypeString' => 'title_player_account'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-EntityToken: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{titleId}.playfabapi.com/Statistic/GetStatistics"
payload := strings.NewReader("{\n \"StatisticNames\": [\n \"SpeedRuns\",\n \"Boosts\"\n ],\n \"Entity\": {\n \"Id\": \"A197412JDA\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-EntityToken", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Statistic/GetStatistics")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"StatisticNames\": [\n \"SpeedRuns\",\n \"Boosts\"\n ],\n \"Entity\": {\n \"Id\": \"A197412JDA\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Statistic/GetStatistics")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"StatisticNames\": [\n \"SpeedRuns\",\n \"Boosts\"\n ],\n \"Entity\": {\n \"Id\": \"A197412JDA\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"Statistics": {
"SpeedRuns": {
"Name": "SpeedRuns",
"Scores": [
"89"
]
}
},
"Entity": {
"Id": "184131840178",
"Type": "title_player_account",
"TypeString": "title_player_account"
}
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}