Automatic Analytics Fields & Events

This page details the fields and events the SDK will report in various modes. See the Anatlyics Overview for initialization details.

Automatic Modes

The auto analytic mode is specified with the KONGREGATE_OPTION_AUTO_ANALYTICS_MODE initialization option. Supported modes include:

• KONG_AUTO_ANALYTICS_MODE_ENABLE_ALL (Default) - All automatic events and fields will be handled by the SDK.
• KONG_AUTO_ANALYTICS_MODE_CLOUD - A subset of automatic events and fields suitable for most server backed games will be handled by the SDK. Fields and events exclude are noted below.
• KONG_AUTO_ANALYTICS_MODE_DISABLE_ALL - No automatic fields or events will be collected.

Optional Filter

The KONGREGATE_OPTION_AUTO_ANALYTICS_FILTER option may be used to exclude specific events or fields from auto anaytics. Specify the list of fields and events you’d like to exclude as a comma seprated string (e.g. session_starts,session_id, etc).

Automatic Fields

These fields will be sent with every event when auto analytics is enabled:

• ad_tracking
• android_id
• bundle_id
• carrier
• client_os_type
• client_os_version
• client_version
• country_code
• data_connection_type
• days_retained
• dev_client_version
• device_event_type
• device_type
• event_time
• event_time_offset
• external_ip_address (full integration only)
• filter_type
• first_client_version
• first_play_time
• first_play_time_offset
• google_ad_id
• ip_address
• is_from_background
• imei
• is_valid
• kong_plus
• kong_user_id
• kong_username
• lang_code
• last_skew_refresh_time
• mac_address
• num_purchases
• num_sessions
• player_id (only in enable_all mode)
• sdk_version
• session_id
• time_skew
• idfa
• idfv
• total_spent_in_usd (only in enable_all mode)
• usd_spent_on_kreds

Automatic Events

These events will be fired by the SDK when auto analytics is enabled.

• installs (only in enable_all mode) - fired when the app is first installed. The utm fields below only have meaning for Google.
  • stub
  • utm_campaign
  • utm_source
  • utm_medium
  • utm_name
  • utm_content
• session_starts - fired at the start of a session.
  • is_from_background
• session_ends - fired at the end of a session.
  • did_crash
  • session_length
  • session_end_time
• player_info - fired when at launch for non guests and when user logs in or out. If your game keeps the users email address or connects with facebook or twitter, you may fire this event whenever one of the relevant fields change.
  • email
  • fb_username
  • fb_email
  • kong_join_date
  • pur_link_date
  • twitter_username
  • twitter_id
• invalid_states - fired when the SDK detects something invalid with the client (e.g. jailbroken)
  • reason

Session Logic Details

A session is defined as a period of mostly uninterrupted use of the app. A session is considered over when it has been in the background for more than 5 minutes. As such, you can expect a session_starts event and new session_id when the app first launches and when it comes to the foreground after sitting in the backgound or closed for more than 5 minutes. Since the SDK can not determine how long the app has been closed or in the backgound until it comes to the foreground again, the session_ends event will not be submitted until the app returns to the foreground. The session_end_time field sent with the event will reflect the time when the session actually ended.

Player Info Details

This event is intended to fire whenever player info details change. It will automatically fired when a non-guest Kongregate user lauches the app, logs, in or out. If your game collects any of player detail fields listed under the event, you should fire the event at launch and whenever one of the details change.

AddEvent("player_info", { "fb_username": "joe_facebook", "fb_email": "joe@gmail.com" });

The SDK will automatically fill in known player_info fields when the event fires.

API Events

These events will be fired when an associated API call is invoked and auto analytics is enabled.

• iap_attempts - AnalyticsServices.startPurchase() (not required for lite integrations)
  • iap_id
  • local_currency_cost
  • local_currency_type
  • product_id
  • usd_cost
• iap_transactions - FinishPurchase(), AddIOSIapTransaction(), or AddGoogleIapTransaction()
  • iap_id
  • local_currency_cost
  • local_currency_type
  • product_id
  • receipt_id
  • total_spent_in_usd (only in enable_all mode and when USD cost available)
  • usd_cost (only with FinishPurchase or currency passed in USD)
• iap_fails - AnalyticsServices.finishPurchase() - (not required for lite integrations)
  • iap_id
  • fail_reason
  • receipt_id