Beamable Documentation

Welcome! Here is everything you need to get setup and become a Beamable expert.

Begin with the Getting Started section, learn more about Beamable features in the Manual, and check out the Script Reference APIs for advanced workflows.

Choose from the following...













.








.

Analytics

Allow game maker to track player behavior

Overview

This page includes everything needed to use this feature in the "Beamable SDK for Unity". Or watch this 5 minute video.

The purpose of this feature is to allow the game maker to track player behavior in the game.

Why Analytics?

Beamable Analytics provides data about how players are playing. This information is vital to designing the best game experience.

If you don't measure it, you can't improve it!

Metrics

Metric information is vital to know as you design, develop, launch, and improve your game. Metrics answer the questions which are central to a game's success.

Here is a partial list.

NameDetail
D1, D7, D30 RetentionHow many players come back after 1, 7, 30 days?
Tutorial CompletionHow many players make it all the way through the new player experience and get past the tutorial?
Ad EngagementHow many players click to watch an ad in the game?
Total Conversion RateHow many players buy something in the game?

KPI

Some metrics are referred to as KPIKPI - A Key Performance Indicator is a metric that helps determine a game's successs because of their high importance.

KPIs are metrics that;

  • Help determine the success of the game
  • Give an understanding of core player behavior
  • Show advancement towards key monetization goals

Beamable Analytics

Beamable offers a complete Analytics FeatureFeature - An individual aspect of the Beamable product used to create a great user experience to prepare game makers for success.

  1. Analytics Events - Historical data regarding a player's user interaction or the system state
  2. Stats - Active data used for read/write of player data
  3. Pipeline Service - The live feed of player data
  4. Amazon's Athena- The analytics database with player history

Game Maker User Experience

During development, the game maker's user experience is as follows.

Steps

Follow these steps to get started.

1. Capture Analytics

In the capture phase, a significant moment of the user-experience is noted and captured by Beamable Analytics. This can be one of the built-in standard events or a custom event created specifically by the game maker.

Standard Events

The great news is that Beamable automatically tracks the most common analytics for you. These are enabled simply by integrating the Beamable SDK into the game project.

Here is a partial list of standard events.

NameDetail
platform_administration_change_emailFor player account
platform_administration_reset_password
platform_cohort_join
platform_commerce_external_revenueFor game monetization
platform_commerce_failed_purchase
platform_commerce_hard_purchase
platform_commerce_virtual_purchase
platform_entitlement_entitlement
platform_group_group_applicationFor player guilds
platform_group_group_create
platform_group_group_invite
platform_group_group_join
platform_group_group_leave
platform_session_dailyFor KPI metrics
platform_session_install
platform_session_session
platform_session_session_end
platform_stats_stats
platform_ua_attributionFor attribute user acquisition campaigns

Custom Events

Beamable allows game makers to create custom analytics and stats.

šŸ“˜

Feature Roadmap

Many Beamable features will be added over time.

  • These C# APIs are currently available as WIPWIP - A Work In Progress feature or workflow is in active development, but not fully released . To learn more, please contact us.

2. View Analytics

The Portal allows the game maker to view and edit player analytics.

The Beamable "Portal"

šŸš§

Feature Roadmap

Many Beamable features will be added over time.

  • A KPIKPI - A Key Performance Indicator is a metric that helps determine a game's success Dashboard may be offered within the Portal in the future. To learn more, please contact us.

3. Query Analytics

With your events and stats captured and stored, queries may be performed against them to learn more about player behavior and help design new game features and content updates.

Options

If you change technology along the way, no problem, Beamable we can back-fill the data.

To learn more about querying Beamable analytics, please contact us.

Analytics Events & Stats

Supports both analytics events and stats. Each use case is unique.

TypeDatabaseDetail
Analytics EventAnalytics Databaseā€¢ Relatively slow
ā€¢ Holds deep history
ā€¢ Answers queries like "When did player X purchase item Y?"

Example: Amazon's Athena
StatTransactional Databaseā€¢ Very fast reads/writes
ā€¢ Data purged after X days
ā€¢ Does not keep history

Example: Mongo DB

Source

The source value is set automatically for each analytics events and stats.

NameDetailSecure?Available?
ClientEvent came directly from front-end (game client)This data is generally more vulnerable to hackers/risksYes
PlatformEvent came from back-endYesYes
Game ServerEvent came from the multiplayer serverYesUpon Request

A Hybrid Approach

While the use cases for events and stats are often different, there are indeed common workflows where both are used in concert. For example. Beamable automatically tracks analytics event (deep history) every time a stat is changed (fast speed). This is the best of both worlds!

Here is more info about each analytics concept.

Events

Events names are namespaced by the source to limit name collision (Ex. Client.GAME_START vs Platform.GAME_START).

The payload may include custom data set by the game maker. This is a flat set of name/value pairs.

Data Structure

Stats

Use Cases

  1. Data Store - A simple place to read/write info (Ex. How many characters does the player own?)
  2. Targeting - Stats are the vector for player segmentation (Ex. A/B testing, targeted offer, focused message campaign, announcement for subset of player-base)

Supported Data Types

  • String - For common alphanumeric data storage
  • Numeric - Supports numeric evaluations on the back-end (<, >, =) and a fast, atomic increment API

šŸ“˜

Best Practice

These hints make efficent use of concepts and workflows.

Stats are designed for simple data types; string or numeric

  • Do not store C# objects
  • Do not store Json blobs

Public vs Private

  • Public Stat - Visible to owning player and others (Ex. Player Alias, Player Avatar)
  • Private Stat - Visible only to the owning player (Ex. "How many characters do I have?")

Advanced

Here are a few advanced configuration options and workflows.

Event Batching

Generally speaking each analytics call from the C# API will result in one client-server communication.

The API supports batching together multiple analytics calls (default max limit is 100) within ONE client-server communication as an optimization.

Updated 6 days ago


Analytics


Allow game maker to track player behavior

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.