Close

Events

Event Type is a definition for a group of similar events. Event Type defines what parameters the events contain and what kind of values those parameters have. All events having the same Event Type must have the same structure regarding parameters and parameter values. The Event Type is identified with a specific parameter (om_event_type).

Event Types

There are three mandatory parameters for each Event Type, which must be present in each event sent to Omniata. These are om_event_type, api_key and UID. If these KVPs are not present, it will not be accepted by Omniata and the data will be lost.

Example

GET https://api.omniata.com/event?uid=1234&api_key=1234abcd&om_event_type=new_level&level=8

Standard Event Types

Omniata has three core Event Types:

  • om_load: indicates that application or session has been started, or reloaded
  • om_revenue: in-app purchases
  • om_user: user details

For more information on the standard Event Types, see section on Event API in API section.

Custom Event Types

Omniata allows customers to send any kind of custom events, defined by customers themselves, with custom parameters and parameter values. The custom event and parameter names can be defined to be anything, e.g. "new_level", "current_level, "app_review", "tutorial_step". The values of these parameters can be any type of data, such as string ("review_completed") or numeric values (8).

When designing Event Types, a good practice is to have the parameter names and values separated.

Good: ...purchased_item=bag_of_gold&purchase_value=8...

Bad: ...bag_of_gold=8...

Why? The good example allows you to easily list different purchase items across different dimensions, and allows visualization of all purchase events. The bad example allows you to only the visualize the bag_of_gold purchases.

Adding Events

To manage and add new Event Types to an event-based Data App navigate to Model > Events. Here you access to:

  • Creating and using Testing Profiles
  • List of Events associated with the Project
  • Logger (shows the real-time event flow for selected Test Profile)
  • Scanner (for adding events and parameters)

When selecting an Event Type, you will see details on all associated Parameters including associated data types. The default values have been automatically identified.

Event Scan

To add events and parameters to a Project, you can scan for available events and parameters under the Scans tab. The Event Scan will scan the events for the period of time selected. The scan results indicate which events and parameters have not been added to the Project, and provide an option to add them. This process can be automated from Settings > General, which adds all new events and parameters daily. NOTE: make sure that the data stream is clean before selecting this option.

Under 'Scan' you can define the lenght of the period to be scanned, the environment, and the number of users. The results page provides you with options to add events and paramteres to the Project.

Data Types

When an Event and Parameter is added to the Project, Omniata automatically identifies the Data Type used. The Data Types can be modified if needed and Omniata supports the following Types:

Data Type

Description

When to use

Big Integer an integer value between -9,223,372,036,854,775,808 and 9,223,372,036,854,775,807 Cases where you sum up very large numbers, or that you multiply 2 large numbers. Summing virtual currency across many users is usually a good use case.
Boolean True (1) or False (0)

Whenever the result has just 2 possible outcomes.

When used as a dimension, you can label both options at will (i.e. “Accepted”, “Rejected”).

When used as a measure, you can sum up the values where the result is True (1) (i.e. “Total Successes”)

Date A date as Unix timestamp in seconds since the epoch. This value is later stored as DATE data type in SQL. Continuous and periodic formatting options are available, such as “Weeks” or “Day of The week”.
Date and Time Date and time as unix timestamp in seconds since the epoch. This value is later stored as DATESTAMP data type in SQL. Continuous and periodic formatting options are available, such as “Weeks” or “Day of The week”
Decimal Number a numeric value with decimals. i.e. 2.99 For example, used with revenue information and averages per user.
Integer an integer value between -2,147,483,648 and 2,147,483,647 Numbers that you are sure will always be within that range. Most cases.

Positive Integer

an integer value between 0 and 4,294,967,295.

Numbers that you are sure will always be positive and within that range, like “count of purchases”.

If you pass a negative value my mistake, the stored value will be 2,147,483,647.

String

128 character string

Useful for names, or alphanumeric ids.

This field can only be used as a dimension.

This article was last updated on February 9, 2016 00:26. If you didn't find your answer here, search for another article or contact our support to get in touch.

Contact Sales

Add Phone Number