/
v3.0.11Get access

getActivePlayerCount

Returns the number of currently active players for the given casino games. A session is required, but the player does not need to be logged in. The optional `kinds` filter narrows the count to specific game kinds.

Request parameters:

Name
DescriptionTypeValuesDefault
gameIds
Casino game ids to count active players for. Must be a non-empty array of numbers.array--
kinds
Optional filter narrowing the count to specific game kinds, for example ["PPG", "EGT"].array["PPG", "EGT"]-

Parameters marked with must be included in the request

Call example:

getActivePlayerCount({
  gameIds: [500043662, 441450468],
  kinds: ['PPG', 'EGT']
})

Response examples:

{
  errorKey: '',
  hasError: false,
  errorMessage: '',
  data: [{
    PartnerId: 1088,
    ProviderKind: 'PPG',
    PlayerCount: 1,
    GameId: 1232282
  }]
}

Response parameters:

NameDescriptionTypeValues
PartnerId
Identifier of the partner ( siteId )number-
PlayerCount
Number of players currently active on the game or kind this row representsnumber-
GameId
Casino game the count belongs tonumber-
ProviderKind
Game kind the count belongs to. Present only when the request passed `kinds` — the backend then groups the counts by kind instead of by gamestring-