Obter estatísticas para entidades

Gets statistics for the specified collection of entities.

Allowed entity token types: title, title_player_account, game_server

Error codes

This operation may return the following PlayFab errors:

Error	Code
InvalidEntityType	1373
NotAuthorized	1089
StatisticNotFound	1195

POST

Statistic

GetStatisticsForEntities

Get Statistics For Entities

curl --request POST \
  --url https://{titleId}.playfabapi.com/Statistic/GetStatisticsForEntities \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "Entities": [
    {
      "Id": "A197412JDA",
      "Type": "title_player_account",
      "TypeString": "title_player_account"
    },
    {
      "Id": "B197412JDB",
      "Type": "title_player_account",
      "TypeString": "title_player_account"
    }
  ],
  "StatisticNames": [
    "SpeedRuns",
    "Boosts"
  ]
}
'

import requests

url = "https://{titleId}.playfabapi.com/Statistic/GetStatisticsForEntities"

payload = {
    "Entities": [
        {
            "Id": "A197412JDA",
            "Type": "title_player_account",
            "TypeString": "title_player_account"
        },
        {
            "Id": "B197412JDB",
            "Type": "title_player_account",
            "TypeString": "title_player_account"
        }
    ],
    "StatisticNames": ["SpeedRuns", "Boosts"]
}
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({
    Entities: [
      {
        Id: 'A197412JDA',
        Type: 'title_player_account',
        TypeString: 'title_player_account'
      },
      {
        Id: 'B197412JDB',
        Type: 'title_player_account',
        TypeString: 'title_player_account'
      }
    ],
    StatisticNames: ['SpeedRuns', 'Boosts']
  })
};

fetch('https://{titleId}.playfabapi.com/Statistic/GetStatisticsForEntities', 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/GetStatisticsForEntities",
  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([
    'Entities' => [
        [
                'Id' => 'A197412JDA',
                'Type' => 'title_player_account',
                'TypeString' => 'title_player_account'
        ],
        [
                'Id' => 'B197412JDB',
                'Type' => 'title_player_account',
                'TypeString' => 'title_player_account'
        ]
    ],
    'StatisticNames' => [
        'SpeedRuns',
        'Boosts'
    ]
  ]),
  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/GetStatisticsForEntities"

	payload := strings.NewReader("{\n  \"Entities\": [\n    {\n      \"Id\": \"A197412JDA\",\n      \"Type\": \"title_player_account\",\n      \"TypeString\": \"title_player_account\"\n    },\n    {\n      \"Id\": \"B197412JDB\",\n      \"Type\": \"title_player_account\",\n      \"TypeString\": \"title_player_account\"\n    }\n  ],\n  \"StatisticNames\": [\n    \"SpeedRuns\",\n    \"Boosts\"\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/GetStatisticsForEntities")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Entities\": [\n    {\n      \"Id\": \"A197412JDA\",\n      \"Type\": \"title_player_account\",\n      \"TypeString\": \"title_player_account\"\n    },\n    {\n      \"Id\": \"B197412JDB\",\n      \"Type\": \"title_player_account\",\n      \"TypeString\": \"title_player_account\"\n    }\n  ],\n  \"StatisticNames\": [\n    \"SpeedRuns\",\n    \"Boosts\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Statistic/GetStatisticsForEntities")

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  \"Entities\": [\n    {\n      \"Id\": \"A197412JDA\",\n      \"Type\": \"title_player_account\",\n      \"TypeString\": \"title_player_account\"\n    },\n    {\n      \"Id\": \"B197412JDB\",\n      \"Type\": \"title_player_account\",\n      \"TypeString\": \"title_player_account\"\n    }\n  ],\n  \"StatisticNames\": [\n    \"SpeedRuns\",\n    \"Boosts\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "EntitiesStatistics": [
      {
        "EntityKey": {
          "Id": "A197412JDA",
          "Type": "title_player_account",
          "TypeString": "title_player_account"
        },
        "Statistics": [
          {
            "Name": "SpeedRuns",
            "Scores": [
              "89"
            ]
          },
          {
            "Name": "Boosts",
            "Scores": [
              "3"
            ]
          }
        ]
      },
      {
        "EntityKey": {
          "Id": "B197412JDB",
          "Type": "title_player_account",
          "TypeString": "title_player_account"
        },
        "Statistics": [
          {
            "Name": "SpeedRuns",
            "Scores": [
              "50"
            ]
          },
          {
            "Name": "Boosts",
            "Scores": [
              "1"
            ]
          }
        ]
      }
    ]
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

Autorizações

X-EntityToken

string

header

obrigatório

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Corpo

application/json

Entities

object[]

obrigatório

Collection of Entity IDs to retrieve statistics for.

Show child attributes

CustomTags

object

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

StatisticNames

string[]

The list of statistics to return for the user. If set to null, the current version of all statistics are returned.

Resposta

code

integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status

string

The Http status code as a string.

data

object

Show child attributes

Exemplo:

{
  "EntitiesStatistics": [
    {
      "EntityKey": {
        "Id": "A197412JDA",
        "Type": "title_player_account",
        "TypeString": "title_player_account"
      },
      "Statistics": [
        { "Name": "SpeedRuns", "Scores": ["89"] },
        { "Name": "Boosts", "Scores": ["3"] }
      ]
    },
    {
      "EntityKey": {
        "Id": "B197412JDB",
        "Type": "title_player_account",
        "TypeString": "title_player_account"
      },
      "Statistics": [
        { "Name": "SpeedRuns", "Scores": ["50"] },
        { "Name": "Boosts", "Scores": ["1"] }
      ]
    }
  ]
}

Última modificação em 6 de outubro de 2026

Tópicos relacionados

Obter estatísticas baseadas em eventos Obter tabela de classificação para entidades Obter tabela de classificação de amigos para a entidade Estatísticas da comunidade Referência da API de estatísticas

⌘I