Standard Analytics Metrics Events

Standard Game Analytics

  • login : This event is triggered when a new game session is created and is used to identify user.
  • register: This event is triggered whenever a new player sign-up and is used to identify new user.
  • gameplay: This event is triggered whenever a gameplay / match is completed. It is used to identify the count of game completed and gameplay duration.
  • purchase: This event is triggered whenever a user completed a transaction. It is used for revenue tracking

Standard Web Analytics

  • web_login: This event is triggered when a user logs into the website and is used to identify user.
  • web_register: This event is triggered whenever a new user sign-up and is used to identify new user.
  • page_load_completed: This event is triggered whenever a page finishes loading successfully. It is used to track page visits and average loading time.
  • page_load_error: This event is triggered whenever a page fails to load. It is used to track loading error.

Event Structures

Standard Analytics

1. login

  • event_type: login
  • event_structure:
{
  "event_type": "login",
  "event": {
    "event_sub_type": "user_login",
    "event_details": {
      "event_label": "game_login",
      "event_action": "successful"
    }
	}
}
📘

Notes:

  • You must set the user information using the SDK's SetUserDetails() and user information will be added automatically by the SDK when the user calls SendUserEvent()
  • Session Ids are also added automatically by the SDK
  • This event triggers when a user logs in or starts a new game session. It identifies the user.

2. register

  • event_type: register
  • event_structure:
{
  "event_type": "register",
  "event": {
    "event_sub_type": "user_register",
    "event_details": {
      "event_label": "game_register",
      "event_action": "successful"
    }
	}
}
📘

Notes:

  • You must set the user information using the SDK's SetUserDetails() and user information will be added automatically by the SDK when the user calls SendUserEvent()
  • Session Ids are also added automatically by the SDK
  • This event is triggered whenever first registers into the game. It identifies new user.

3. gameplay

  • event_type: gameplay
  • event_structure:
{
  "event_type": "gameplay",
  "event": {
    "event_sub_type": "game_complete",
    "event_details": {
      "event_label": "game_mode",
      "event_action": "completed",
      "game_duration": 123
    }
	}
}
📘

Notes:

  • event_label can be customized to whatever game_mode type is being completed
  • You must set the user information using the SDK's SetUserDetails() and user information will be added automatically by the SDK when the user calls SendUserEvent()
  • Session Ids are also added automatically by the SDK
  • game_duration is to be filled with the time for the match / stage to be cleared in seconds.
  • This event is triggered whenever a gameplay / match / stage is completed. It identifies number of games & average gameplay duration.

4. purchase

  • event_type: purchase
  • event_structure:
{
  "event_type": "purchase",
  "event": {
    "event_sub_type": "ingame_shop",
    "event_details": {
      "event_label": "item_name",
      "event_action": "completed",
      "spend": 0.0
    }
	}
}
📘

Notes:

  • event_label can be customized to shop name / item name.
  • You must set the user information using the SDK's SetUserDetails() and user information will be added automatically by the SDK when the user calls SendUserEvent()
  • Session Ids are also added automatically by the SDK
  • spend is to be filled with the amount spent by the user in USD / other currency equivalent (must be in float / int)
  • This event is triggered whenever a transaction is successfully completed. It identifies revenue.

Standard Web Analytics

1. Web Login

  • event_type: web_login
  • event_structure:
{
  "event_type": "web_login",
  "event": {
    "event_sub_type": "user_login",
    "event_details": {
      "event_label": "web_login",
      "event_action": "successful"
    }
	}
}
📘

Notes:

  • You must set the user information using the SDK's SetUserDetails() and user information will be added automatically by the SDK when the user calls SendUserEvent()
  • Session Ids are also added automatically by the SDK
  • UTMs are scraped and added automatically by the SDK
  • This event triggers when a user logs in or starts a new game session. It identifies the user.

2. Web Register

  • event_type: web_register
  • event_structure:
{
  "event_type": "web_register",
  "event": {
    "event_sub_type": "user_register",
    "event_details": {
      "event_label": "web_register",
      "event_action": "successful"
    }
	}
}
📘

Notes:

  • You must set the user information using the SDK's SetUserDetails() and user information will be added automatically by the SDK when the user calls SendUserEvent()
  • Session Ids are also added automatically by the SDK
  • UTMs are scraped and added automatically by the SDK
  • This event triggers when a user logs in or starts a new game session. It identifies the user.

3. Page Load Completed

  • event_type: page
  • event_structure:
{
  "event_type": "page",
  "event": {
    "event_sub_type": "page_load_completed",
    "event_details": {
      "event_label": "page_name",
      "event_action": "successful",
      "url": "http://www.abc.xyz/page_name",
      "load_time": 1150,
      "is_entry_page": false
    }
	}
}
📘

Notes:

  • You must set the user information using the SDK's SetUserDetails() and user information will be added automatically by the SDK when the user calls SendUserEvent()
  • Session Ids are also added automatically by the SDK
  • UTMs are scraped and added automatically by the SDK
  • load_time is to be filled with the duration taken to load the page
  • url is to be filled with the url of the page
  • is_entry_page is to be filled with a bool of whether the page visited is the user landing page
  • This events is triggered whenever a user visited a page and it load successfully. This is used to determine page visits statistic and average loading time.

4. Page Load Error

  • event_type: page
  • event_structure:
{
  "event_type": "page",
  "event": {
    "event_sub_type": "page_load_error",
    "event_details": {
      "event_label": "page_name",
      "event_action": "error_code",
      "url": "http://www.abc.xyz/page_name",
      "load_time": 1125,
      "is_entry_page": false
    }
	}
  
}
📘

Notes:

  • You must set the user information using the SDK's SetUserDetails() and user information will be added automatically by the SDK when the user calls SendUserEvent()
  • Session Ids are also added automatically by the SDK
  • UTMs are scraped and added automatically by the SDK
  • event_action is to be filled with the type of error code (e.g. 404, 502, etc).
  • load_time is to be filled with the duration taken to load the page
  • url is to be filled with the url of the page
  • is_entry_page is to be filled with a bool of whether the page visited is the user landing page
  • This event is triggered whenever a page fails to load. This is used to show error count data.