Sweepstakes Game Session

Event Key

ootb_sweepstakes_game_session

This event should be sent when a game is closed, summarizing a game session. Overview of game session.

Event Key	Event Name	Type
`ootb_sweepstakes_game_session`	OOTB Sweepstakes 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 OOTB Sweepstakes 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_gc_balance": 500.00,
    "ootb_end_gc_balance": 500.00,
    "ootb_start_sc_balance": 500.00,
    "ootb_end_sc_balance": 500.00,
    "ootb_gc_stakes": 200.00,
    "ootb_sc_stakes": 200.00,
    "ootb_sc_win_amount": 100.00,
    "ootb_gc_used": 50.00,
    "ootb_gc_win_amount": 100.00,
    "ootb_gross_gaming_revenue": 100.00,
    "ootb_number_of_sc_bets": 2,
    "ootb_number_of_gc_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": "brand123",
    "ootb_license": "USA"
  }
}

Parameters

Parameter Key	Parameter Name	Type	Description	Mandatory for Opti-X	Events-based Integration required?
`ootb_session_start_timestamp`	Session Start Timestamp	String	ISO 8601 datetime of session start.	Yes	Optional
`ootb_session_end_timestamp`	Session End Timestamp	String	ISO 8601 datetime of session end.	Yes	Mandatory
`ootb_game_code`	Game Code	String	Unique identifier for the game.	Yes	Mandatory
`ootb_game_name`	Game Name	String	Name of the game played.	No	Mandatory
`ootb_game_category`	Game Category	String	Game category (e.g., Slots, Table Games).	No	Enrichment- used for out-of-the-box attribute
`ootb_start_gc_balance`	Start Gold Coins Balance	Decimal	Player's gold coins balance at the beginning of the session.	No	Optional
`ootb_start_sc_balance`	Start Sweep Coins Balance	Decimal	Player's sweep coins balance at the beginning of the session.	No	Optional
`ootb_end_gc_balance`	End Gold Coins Balance	Decimal	Gold Coins balance at session end.	No	Optional
`ootb_end_sc_balance`	End Sweep Coins Balance	Decimal	Sweep Coins balance at session end.	No	Optional
`ootb_gc_stakes`	Gold coins stakes	Decimal	Gold coins bet during session.	Yes	Mandatory
`ootb_sc_stakes`	Sweep coins stakes	Decimal	Sweep coins bet during session.	Yes	Mandatory
`ootb_sc_win_amount`	Sweep coins Win Amount	Decimal	Sweep coins won.	No	Enrichment- used for out-of-the-box attribute
`ootb_gc_used`	Gold Coins Used	Decimal	Gold coins amount used.	No	Enrichment- used for out-of-the-box attribute
`ootb_gc_win_amount`	Gold Coins Win Amount	Decimal	Gold coins amount won.	No	Enrichment- used for out-of-the-box attribute
`ootb_gross_gaming_revenue`	Gross Gaming Revenue	Decimal	Revenue from the game session.	Yes	Mandatory
`ootb_number_of_sc_bets`	Number of SC Bets	Number	Count of sweep coins bets or game rounds.	Yes	Enrichment- used for out-of-the-box attribute
`ootb_number_of_gc_bets`	Number of GC Bets	Number	Count of gold coins bets or game rounds.	Yes	Enrichment- used for out-of-the-box attribute
`ootb_game_session_reference`	Game Session Reference	String	Reference ID to link game events.	Yes	Optional
`ootb_language`	Language	String	Language setting of the player.	No	Optional
`ootb_country`	Country	String	Player's country code.	No	Optional
`ootb_platform`	Platform	String	Platform used, e.g., iOS, Android.	No	Enrichment- used for out-of-the-box attribute
`ootb_launch_location`	Launch Location	String	Game source container (home, featured, etc.).	No	Optional
`ootb_launch_location_index`	Launch Location Index	Number	Index within the container.	No	Optional
`ootb_channel`	Channel	String	Device type or access channel.	No	Optional
`ootb_brand`	Brand	String	Brand name or identifier.	No	Optional
`ootb_license`	License	String	Jurisdiction of operation or licensing authority.	No	Optional

Explanation

event: Set to ootb_sweepstakes_game_launch to mark the beginning of a user's engagement with a specific game title.
context:
- ootb_launch_timestamp: Used to calculate the exact start time of the user's engagement.
- ootb_game_code: The system ID used to aggregate data for specific game performance.
- ootb_game_name: The display name used for reporting and personalization tokens.
- ootb_game_category: Allows for segmentation based on game preference (e.g., "Slots Players").
- ootb_start_gc_balance: Establishes the user's "Social" liquidity baseline before play begins.
- ootb_start_sc_balance: Establishes the user's "Promotional" liquidity baseline before play begins.
- ootb_game_session_reference: A unique key linking this event to subsequent session/close events.
- ootb_language: The language setting of the player during the event.
- ootb_country: The player's country location during the event.
- ootb_platform: The platform environment (e.g., iOS, Android) where the event occurred.
- ootb_launch_location: The UI container/source where the game was initiated (e.g., Homepage, Search).
- ootb_launch_location_index: The numerical position index within the launch container.
- ootb_channel: The device type or access channel used.
- ootb_brand: The specific brand or skin associated with the user/event.
- ootb_license: The regulatory license under which the operation is occurring.