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

📘
Events-based Integration (EBI): parameter classification
The Events-based Integration column shows how each parameter is treated when you onboard using an Events-based Integration:

Mandatory — required for the event to be ingested and processed correctly.

Mandatory if required for the execution channel integration — required only when the relevant execution channel (e.g., email, SMS, push, WhatsApp) is part of your integration.

Enrichment- used for out-of-the-box attribute — not required, but when provided it powers an Optimove out-of-the-box attribute.

Optional — accepted and stored when provided; not required and not tied to an OOTB attribute.

Parameter Key	Parameter Name	Type	Description	Mandatory for Opti-X?	Events-based Integration
`ootb_session_start_timestamp`	Session Start Timestamp	String	ISO 8601 datetime of starting a casino game session.	Yes	Optional
`ootb_session_end_timestamp`	Session End Timestamp	String	ISO 8601 datetime of ending a casino game session.	Yes	Mandatory
`ootb_game_code`	Game Code	String/Number	Game unique identifier/Game ID.	Yes	Mandatory
`ootb_game_name`	Game Name	String	The name of the game.	No	Mandatory
`ootb_game_category`	Game Category	String	The category of the game (e.g., Slots, Roulette, Table, etc.).	No	Enrichment- used for out-of-the-box attribute
`ootb_start_balance`	Start Balance	Decimal	Player balance on game start.	No	Optional
`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).	No	Optional
`ootb_stakes`	Stakes	Decimal	Monetary real value that was wagered (real bet amount).	Yes	Mandatory
`ootb_real_win_amount`	Real Win Amount	Decimal	Monetary real value that was won.	No	Enrichment- used for out-of-the-box attribute
`ootb_bonus_used`	Bonus Used	Decimal	Total bonus amount that was wagered/used in the game session.	No	Enrichment- used for out-of-the-box attribute
`ootb_bonus_win_amount`	Bonus Win Amount	Decimal	Total bonus amount that was won.	No	Enrichment- used for out-of-the-box attribute
`ootb_gross_gaming_revenue`	Gross Gaming Revenue	Decimal	Total revenue (GGR).	Yes	Mandatory
`ootb_number_of_bets`	Number of Bets	Number	Total number of bets/games played in a session.	Yes	Enrichment- used for out-of-the-box attribute
`ootb_game_session_reference`	Game Session Reference	String	Reference to the game session event (optional).	Yes	Optional
`ootb_language`	Language	String	The language of the player.	No	Optional
`ootb_country`	Country	String	The country of the player.	No	Optional
`ootb_platform`	Platform	String	The platform used (e.g., iOS, Android).	No	Enrichment- used for out-of-the-box attribute
`ootb_launch_location`	Launch Location	String	The container where the game was launched from (e.g., home, recently played, new game). Optional.	No	Optional
`ootb_launch_location_index`	Launch Location Index	Number	Index of where in the container the game was launched from (optional).	No	Optional
`ootb_channel`	Channel	String	The channel through which an event was initiated (e.g., Mobile, Desktop, Tablet).	No	Optional
`ootb_brand`	Brand	String	Brand ID/Name.	No	Optional
`ootb_license`	License	String	Where they’re licensed to operate.	No	Optional