Game Session
Event Key
ootb_game_session
This event should be sent when a game is closed, summarizing a game session.
Event Key | Event Name | Type |
---|---|---|
ootb_game_session | OOTB Game Session | Simple event |
Event Structure
The mandatory properties (tenant
, timestamp
, event
, and customer
) are required for all events and documented in detail on the Mandatory Properties page. Below is the JSON structure for the context-specific properties of the Game Session Event:
{
"context": {
"session_start_timestamp": "2024-05-27T10:30:00Z",
"session_end_timestamp": "2024-05-27T10:32:00Z",
"game_code": "game456",
"game_name": "Blackjack",
"game_category": "Table Games",
"start_balance": 500.00,
"end_balance": 500.00,
"stakes": 200.00,
"real_win_amount": 100.00,
"bonus_used": 50.00,
"bonus_win_amount": 100.00,
"ggr": 100.00,
"no_of_bets": 2,
"game_session_ref": "game_ses_456",
"language": "English",
"Country": "USA",
"platform": "iOS",
"launch_location": "BingoLobby",
"launch_location_index": 1,
"channel": "Mobile",
"brand": "",
"license": "USA"
}
}
Parameters
Parameter Key | Parameter Name | Type | Description |
---|---|---|---|
session_start_timestamp | Session Start Timestamp | String | ISO 8601 datetime of starting a casino game session. |
session_end_timestamp | Session End Timestamp | String | ISO 8601 datetime of ending a casino game session. |
game_code | Game Code | String/Number | Game unique identifier/Game ID. |
game_name | Game Name | String | The name of the game. |
game_category | Game Category | String | The category of the game (e.g., Slots, Roulette, Table, etc.). |
start_balance | Start Balance | Decimal | Player balance on game start. |
end_balance | End Balance | Decimal | The total balance at the end of the game session (start balance - stakes + real win amount + bonus win amount). |
stakes | Stakes | Decimal | Monetary real value that was wagered (real bet amount). |
real_win_amount | Real Win Amount | Decimal | Monetary real value that was won. |
bonus_used | Bonus Used | Decimal | Total bonus amount that was wagered/used in the game session. |
bonus_win_amount | Bonus Win Amount | Decimal | Total bonus amount that was won. |
gross_gaming_revenue | Gross Gaming Revenue | Decimal | Total revenue (GGR). |
number_of_bets | Number of Bets | Number | Total number of bets/games played in a session. |
game_session_reference | Game Session Reference | String | Reference to the game session event (optional). |
language | Language | String | The language of the player. |
country | Country | String | The country of the player. |
platform | Platform | String | The platform used (e.g., iOS, Android). |
launch_location | Launch Location | String | The container where the game was launched from (e.g., home, recently played, new game). Optional. |
launch_location_index | Launch Location Index | Number | Index of where in the container the game was launched from (optional). |
channel | Channel | String | The channel through which an event was initiated (e.g., Mobile, Desktop, Tablet). |
brand | Brand | String | Brand ID/Name. |
license | License | String | Where they’re licensed to operate. |
Updated 2 days ago