Analytics

At Neon, we prioritize providing you with the insights necessary to effectively manage your business. Our dashboard offers a wide array of reports, and if you require additional analytics reports, please don't hesitate to contact [email protected].

We deliver hourly and daily analytics events directly to your AWS S3 bucket in json gz format. Events are separated by sandbox and production environments, ensuring accurate tracking and analysis [Sample File].

This document serves as a comprehensive guide to the analytics events and their associated attributes used within our application. These events play a vital role in tracking user interactions, behaviors, and other essential metrics, enabling you to enhance the user experience and make informed, data-driven decisions.

S3 Configuration

Set the following bucket policy on your S3 bucket.

🚧
Be sure to replace BUCKET_NAME in the policy below with your actual bucket name.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Principal": {
                "AWS": "arn:aws:iam::171666793654:role/NeonS3Access"
            },
            "Action": [
                "s3:AbortMultipartUpload",
                "s3:DeleteObject",
                "s3:GetObject",
                "s3:ListBucket",
                "s3:GetBucketLocation",
                "s3:PutObject"
            ],
            "Resource": [
                "arn:aws:s3:::BUCKET_NAME",
                "arn:aws:s3:::BUCKET_NAME/*"
            ]
        }
    ]
}

Event Details

Analytics events are systematically logged across our application to capture diverse user actions and behaviors. Each event provides invaluable insights into how users engage with our storefront and navigate through the purchasing process. Each event object in the file will include the keys:

event_time: Timestamp indicating when the event occurred
session_id: Unique identifier (integer) for the user session during which the event took place
device_id: Identifier for the device used by the user
event_type: Type of event triggered, providing context for the user action or behavior (string object)
event_properties: Various attributes sent with each event_type object
os_name: Name of the operating system running on the user’s device (i.e., “Apple iPhone”)
browser_family: Browser type or family used to access the application (i.e., “Safari”)
browser_major_version: Major version number of the browser (i.e., “16.3”)
geo_city: City inferred from the user’s IP address (i.e., “Ottawa”)
geo_region: Geographic region, state, or province inferred from the user’s IP address (i.e., “Kansas”)
geo_country: Country inferred from IP address (i.e., "United States")
ip: Public IP address of the user’s device at the time of the event
log_version_id: Internal version identifier used to track changes in event logging schema

📘
Frontend events can be potentially blocked by Ad-blockers

Event Type and Property Definition

Event Types	Event Description	Source	Event Properties
Storefront Opened	Triggered when the storefront is opened	Frontend	`storefront_id` `environment_id` `player_id(optional)` `metadata(optional)` `player_country(optional)`
Storefront Property Sign In Clicked	Triggered when a player initiates a sign-in from the main menu on the web store	Frontend	`storefront_id` `environment_id` `player_id(optional)` `metadata(optional)` `player_country(optional)`
Product Price Sign In Clicked	Triggered when a player initiates a sign-in from an item on the web store	Frontend	`storefront_id` `environment_id` `player_id(optional)` `metadata(optional)` `player_country(optional)`
Auth Code Created	Triggered on the backend when an auth code is created. This happens when the user begins the auth flow that uses the auth API	Backend	`storefront_id` `environment_id` `player_id(optional)` `metadata(optional)`
Lock Button Clicked	Triggered when the user clicks on a locked item in the web store	Frontend	`storefront_id` `environment_id` `offer_sku` `player_id(optional)` `metadata(optional)` `player_country(optional)`
Product Clicked	Triggered when the user clicks on a product to open product detail modal. If the storefront is setup to send the user to the checkout when a product is clicked, this event is not triggered	Frontend	`storefront_id` `environment_id` `offer_sku` `player_id(optional)` `metadata(optional)` `player_country(optional)`
Checkout Created	Triggered when a checkout is created	Backend	`storefront_id(optional)` `environment_id` `player_id(optional)` `metadata(optional)` `offer_skus` `checkout_id` `player_country(optional)`
Payment Method Selected	Triggered when a payment method is selected	Frontend	`storefront_id(optional)` `environment_id` `player_id(optional)` `metadata(optional)` `checkout_id` `payment_method` `player_country(optional)`
Place Order Button Clicked	Triggered when the user clicks on the "Place Order" button in checkout	Frontend	`storefront_id(optional)` `environment_id` `player_id(optional)` `metadata(optional)` `checkout_id` `player_country(optional)`
Checkout Completion Attempted	Triggered by the backend when a user attempts to complete a checkout	Backend	`storefront_id(optional)` `environment_id` `player_id(optional)` `metadata(optional)` `checkout_id` `player_country(optional)`
Checkout Completed	Triggered when a checkout has been successfully completed	Backend	`storefront_id(optional)` `environment_id` `player_id(optional)` `metadata(optional)` `offer_skus` `checkout_id` `purchase_id` `marketing_email_consent` `player_country(optional)`
Checkout Payment Failed	Triggered when a payment failure occurs during checkout	Backend	`storefront_id(optional)` `environment_id` `player_id(optional)` `metadata(optional)` `checkout_id` `payment_method(optional)` `player_country(optional)`
Checkout Back Clicked	Triggered when the player clicks on the back icon on the checkout page	Frontend	`storefront_id(optional)` `environment_id` `player_id(optional)` `metadata(optional)` `checkout_id` `player_country(optional)`
Purchase Completed Modal Displayed	Triggered when the player sees the purchase complete modal with order information	Frontend	`storefront_id(optional)` `environment_id` `player_id(optional)` `metadata(optional)` `checkout_id` `purchase_id` `player_country(optional)`
Continue Shopping Clicked	Triggered when the player clicks on "continue shopping" in the purchase complete modal to close the modal and redirect to the storefront	Frontend	`storefront_id(optional)` `environment_id` `player_id(optional)` `metadata(optional)` `checkout_id` `purchase_id` `player_country(optional)`
Continue Game Clicked	Triggered when the player clicks on "Go to the Game " in the purchase complete modal to close the modal and redirect to the game. Only applicable to mobile phones	Frontend	`storefront_id(optional)` `environment_id` `player_id(optional)` `metadata(optional)` `checkout_id` `purchase_id` `player_country(optional)`
Refund Processed	Triggered when a refund is processed for a player	Backend	`storefront_id(optional)` `environment_id` `player_id(optional)` `metadata(optional)` `checkout_id` `purchase_id` `refund_id` `player_country(optional)`
Storefront Closed	Triggered when the store is closed or the player redirects to another page	Frontend	`storefront_id` `environment_id` `player_id(optional)` `metadata(optional)` `player_country(optional)`
Saved Payment Method Added	Triggered when a new payment method is successfully added	Backend	`storefront_id` `environment_id` `player_id(optional)` `metadata(optional)` `payment_method` `is_first_payment_method` `total_saved_cards` `total_saved_payment_methods` `is_default`
Card Payment Method Deleted	Triggered when the player deletes their card as saved a payment method	Backend	`storefront_id` `environment_id` `player_id(optional)` `metadata(optional)` `payment_method` `total_saved_cards` `total_saved_payment_methods`

Property Definition

storefront_id: Unique identifier of the storefront
environment_id: Environment identifier associated with the storefront; different for sandbox and production
player_id: Identifier of a player
offer_sku: Unique SKU value associated with a particular offer within the storefront
offer_skus: SKUs for offers associated with this event
metadata: Additional contextual data sent with Auth or checkout APIs
checkout_id: Unique identifier assigned to each checkout process initiated by a user
purchase_id: Purchase identifier uniquely identifies each purchase transaction within our system
refund_id: Unique identifier for a processed refund transaction within our system
player_country: Player country in ISO 3166-1 alpha-2 (i.e., "US")
payment_method: A string indicating the type of payment method used (e.g., "credit_or_debit_card").
is_first_payment_method: A boolean indicating whether this is the first payment method saved for the player.
total_saved_cards: A number representing the total count of saved cards for the player.
total_saved_payment_methods: A number representing the total count of saved payment methods for the player.
is_default: A boolean indicating whether this payment method is set as the default.