Close

Quickstart

Omniata allows you to integrate several different data sources to enable a wide range of use cases. In the following, we will go through integrating a new mobile application in an Omniata Project. This guide will review all that is needed to integrate a real-time event-based application, and integrate Custom Events that are specific to your use cases.

All projects in Omniata require an active Organization, a high level domain that contains all projects related to (for example) a Game Studio. In case you do not have an active organization contact the support team.

Content:

Start a New Omniata Application

To start the integration for a new Mobile App go to your Omniata home page and select New Project. Your home page follows the structure:

https://{orgname}.panel.omniata.com/

Projects can be of 3 different types:

Project type Description
Applications A data container for mobile, web or desktop applications that are able to send data to an API. This includes mobile games that use the Omniata SDK, or mobile games that redirect data via server-side traffic.
External Databases A container for reading data from external databases. Allows visualization of charts and creation of dashboards without Omniata processing.
External Services A data container for Ad Networks and/or Attribution Partner integrations. Data is isolated for later unification with mobile Applications for user acquisition.

Select Applications to continue, Omniata will list a few project templates that contain a set of pre-made metrics and dashboards, these packages are fully editable and extendable. For example, if your app is a free-to-play (F2P) game select the “OM F2P” package. This will import Omniata default dashboards with metrics such as DAU, ARPU or LTV; to know more about what this package contains check out the Free to Play Metrics (F2P) guide.

The next page will show all available elements the package contains. Navigate to the bottom, fill in the Application Name and select “Create Project”.

Create Application API Keys

After you install the first package into your application Omniata will request again the Application Name for the API Keys and a few configuration options.

The default session timeout length is 30 minutes, which means that after 30 minutes of no data traffic to Omniata a new session will be created. We recommend changing this value according to your own session policies. You can also configure global user permissions on this page, although is recommended to do so in later stages.

Once you save the configurations, you will be directed to the Applications list. Here you can note that one API Key is generated for each available environment, typically you will find Development, Staging and Production environments by default. Take note of the API keys, since this is a required parameter to track activity.

An API Key isolates a user within the key; while you can add more keys for the same Application and Environment, users with the same ID will be treated as two independent users if their API keys are different.

Enable Data Storage

To enable data storage we will use Google Big Query. You should have at hand the data storage credential details and Key file that are provided upon organization creation. If you do not have this information, contact your organization owner.

The credential details are needed for each environment the application is using. The credentials share a common structure and are simple to add. Navigate to Integrate -> Databases -> New -> Add BigQuery Credentials to start.

Name Description
Environment The environment for which you are enabling the data storage.
Service Mail A unique email provided for the organization and shared across Omniata applications. This email enables the panel to access your Google Cloud project. This is provided as part of the confirmation of new organization created.
BigQuery Project Id The project name for the organization. The name is a simple structure that follows the patter omniata-{orgname}, for example, if the organization is “Acme” the project name would be omniata-acme. This is provided as part of the confirmation of new organization created.
Dataset The name of the application dataset in the current environment. The dataset name is a construct of organization name, application name and environment such that {orgname}_{appname}_{environment} is used. For example, if the organization name is “Acme”, the application name is “Super Chess” and we are setting up the “Production” environment the dataset name would be acme_super_chess_production. Notice that the application name can be found in the Settings -> Project Settings menu.
Key file An authorization key file that works in conjunction with the above configuration. This is provided as part of the confirmation of new organization created.

Once the above configuration is completed, the dashboards might still show an error message indicating that no data was found. This is to be expected for new integrations since there is no data stored yet. If you get a different type of error check our support information for more details on how to proceed.

Add Omniata Tracking

To make application integration easier, Omniata provides ready-made SDKs to use the Event API and Channel API for Android, iOS and Unity. For web Applications a PHP/JS version of the SDK is also available.

Application developers are strongly encouraged to use these SDKs instead of using their own custom implementation. The high-level features of the SDKs are:

Event API

  • Easy sending of Omniata events and support for sending custom events.
  • Non-blocking application call.
  • Persistent event storage.
  • Network reachability check.
  • SSL connections.
  • Retry mechanism.
  • Automatic parameter tracking for user segmentation.

Channel API

  • Sending Channel API calls and asynchronously receiving the content.
  • SSL connections.

SDKs Overview

Select the SDK of your preference to continue. In case you are using a server-side integration continue with “Server Side” from the list below.

Platform Links Version Release Date
iOS Source code
API details
2.2.7 7 Nov 2016
Android Source code
API details
2.1.14 17 Nov 2016
Unity3D Source code
API details
1.3.23 15 Dec 2016
PHP Source code
API details
1.0.0 6 Feb 2016
JavaScript Source code
API details
1.0.0 9 Mar 2016
Server Side Source Code
API details
- 15 Dec 2015

This article was last updated on April 20, 2017 12:04. If you didn't find your answer here, search for another article or contact our support to get in touch.