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": {
"ootb_session_start_timestamp": "2024-05-27T10:30:00Z",
"ootb_session_end_timestamp": "2024-05-27T10:32:00Z",
"ootb_game_code": "game456",
"ootb_game_name": "Blackjack",
"ootb_game_category": "Table Games",
"ootb_start_balance": 500.00,
"ootb_end_balance": 500.00,
"ootb_stakes": 200.00,
"ootb_real_win_amount": 100.00,
"ootb_bonus_used": 50.00,
"ootb_bonus_win_amount": 100.00,
"ootb_gross_gaming_revenue": 100.00,
"ootb_number_of_bets": 2,
"ootb_game_session_reference": "game_ses_456",
"ootb_language": "English",
"ootb_country": "USA",
"ootb_platform": "iOS",
"ootb_launch_location": "BingoLobby",
"ootb_launch_location_index": 1,
"ootb_channel": "Mobile",
"ootb_brand": "",
"ootb_license": "USA"
}
}
Parameters
Parameter Key | Parameter Name | Type | Description |
---|---|---|---|
ootb_session_start_timestamp | Session Start Timestamp | String | ISO 8601 datetime of starting a casino game session. |
ootb_session_end_timestamp | Session End Timestamp | String | ISO 8601 datetime of ending a casino game session. |
ootb_game_code | Game Code | String/Number | Game unique identifier/Game ID. |
ootb_game_name | Game Name | String | The name of the game. |
ootb_game_category | Game Category | String | The category of the game (e.g., Slots, Roulette, Table, etc.). |
ootb_start_balance | Start Balance | Decimal | Player balance on game start. |
ootb_end_balance | End Balance | Decimal | The total balance at the end of the game session (start balance - stakes + real win amount + bonus win amount). |
ootb_stakes | Stakes | Decimal | Monetary real value that was wagered (real bet amount). |
ootb_real_win_amount | Real Win Amount | Decimal | Monetary real value that was won. |
ootb_bonus_used | Bonus Used | Decimal | Total bonus amount that was wagered/used in the game session. |
ootb_bonus_win_amount | Bonus Win Amount | Decimal | Total bonus amount that was won. |
ootb_gross_gaming_revenue | Gross Gaming Revenue | Decimal | Total revenue (GGR). |
ootb_number_of_bets | Number of Bets | Number | Total number of bets/games played in a session. |
ootb_game_session_reference | Game Session Reference | String | Reference to the game session event (optional). |
ootb_language | Language | String | The language of the player. |
ootb_country | Country | String | The country of the player. |
ootb_platform | Platform | String | The platform used (e.g., iOS, Android). |
ootb_launch_location | Launch Location | String | The container where the game was launched from (e.g., home, recently played, new game). Optional. |
ootb_launch_location_index | Launch Location Index | Number | Index of where in the container the game was launched from (optional). |
ootb_channel | Channel | String | The channel through which an event was initiated (e.g., Mobile, Desktop, Tablet). |
ootb_brand | Brand | String | Brand ID/Name. |
ootb_license | License | String | Where they’re licensed to operate. |
Explanation
-
event: The event name is set to
ootb_game_session
, reflecting the nature of the event. -
context:
ootb_session_start_timestamp
: Records the date and time the game session started.ootb_session_end_timestamp
: Records the date and time the game session ended.ootb_game_code
: Uniquely identifies the game.ootb_game_name
: Specifies the name of the game.ootb_game_category
: Categorizes the game (e.g., Slots, Roulette, Table, etc.).ootb_start_balance
: Reflects the player's balance at the start of the session.ootb_end_balance
: Indicates the player's balance at the end of the session.ootb_stakes
: The real monetary value wagered during the session.ootb_real_win_amount
: The actual monetary win amount.ootb_bonus_used
: The total bonus amount wagered or used.ootb_bonus_win_amount
: The total bonus amount won.ootb_gross_gaming_revenue
: Total revenue generated from the session.ootb_number_of_bets
: The total number of bets or games played in the session.ootb_game_session_reference
: Optionally provides a reference to the game session event.ootb_language
,ootb_country
,ootb_platform
,ootb_channel
,ootb_brand
, andootb_license
: Provide additional context regarding the player and environment.ootb_launch_location
andootb_launch_location_index
: Optionally indicate where and the position from which the game was launched.
Updated 14 days ago