/
v3.0.11Get access

getGameStatistics

This method calculates high-level operational metrics like total engagement (PlayersCount), total payouts (TotalWinAmount), and highlights major wins (TopWinAmount) while providing a currency conversion rate (USDRate) for global financial reporting.

Request parameters:

NameDescriptionTypeValuesDefault
gameId
The unique ID of the game being queried.number--

Parameters marked with must be included in the request

Call example:

getGameStatistics({
  gameId: 500000397
})

Response examples:

{
  result: 0,
  details: {
    PartnerId: 18751367,
    GameId: 555580138,
    ProviderId: 267,
    PlayersCount: 1145,
    TotalWinAmount: 100282.99,
    TopWinAmount: 4117.5,
    TopWinPlayerName: 'ALVES P***',
    Currency: 'BRL',
    USDRate: 0.193862893,
    StartTime: '2026-06-08T14:57:05.3965928',
    EndTime: '2026-06-08T15:07:34.0415475'
  }
}

Response parameters:

NameDescriptionTypeValues
GameId
The unique ID of the game being queried.number-
PartnerId
The ID of the operator, platform, or partner hosting the game session.number-
ProviderId
The identifier of the game studio or provider that created the gamenumber-
Currency
The main currency used during this specific statistical timeframe.string-
PlayersCount
The total number of unique players who participated in the game during this interval.number-
StartTime
The ISO-8601 UTC timestamp marking when this statistical tracking window started.string-
EndTime
The ISO-8601 UTC timestamp marking when this statistical tracking window ended.string-
TopWinAmount
The highest individual payout won by a single player during this window (in local currency).number-
TopWinPlayerName
The masked username of the player who achieved the highest winstring-
TotalWinAmount
The cumulative amount of all winnings paid out to all players combined (in local currency).number-
USDRate
The conversion exchange rate from the local currency (BRL) to USD at the time of calculation.number-