When you have identified the API Keys in Omniata and selected your integration method, you can start integrating. This is a critical phase: integrating the standard Omniata Event Types properly, designing your custom Event Types with care, and ensuring that the event flow is correct during the user's session are vital part of ensuring high data quality. Omniata has tools for monitoring the event data which is sent. Before starting, please be aware that Omniata has an event lenght limit of 2,048 total characters, including all headers and required fields. In addition, the limit for any single KVP (parameter value) is 255 characters.
Omniata has three standard events of which two should need to be integrated:
If you are using one of the SDKs, many parameters get assigned values automatically.
Using custom Event Types is very flexible with Omniata. A best practice for designing an event is it consist of a summary of an action, with only relevant parameters included. 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...
The Event Console shows incoming events in real-time. The Event Console can be accessed by going to Model > Events. The Event Console tracks one user ID-API key combination at a time, which makes examining the event flow easy. You also get sample code for the standard Event Types. The code contains the specified user ID and API key, so you can test the integration by copy-pasting the sample code into the application code.
If you want to test the use of the Event Console manually before starting the actual integration, you can use the REST sample code. Copy-paste it into the address bar of web browser and press enter, and the corresponding event will be shown in the Event Console.
Event Scan shows all Event Types which have been received by Omniata and the included parameters. The Event Scanner can be accessed by going to Model > Events and then clicking "Scan". The Event Scanner can be used in almost real-time, with a 5-minute delay due to event processing. The Event Scanner can also automatically define all found Event Types and new event parameters, as well as create Event Fields for them. You have also an option to set that all new event and parameters are automatically updated on daily basis. For more details on this, see section Administration > Project Settings.