Integrate your app

In order to use Localytics, you need to integrate your app with the Localytics SDK.

Integration is the process of putting the Localytics SDK into your application. Integration is very quick, but it's important to pay attention to the following guides in order to integrate as successfully as possible. Review the docs on Dashboard before integrating to get a sense of how this integration will affect Dashboard users.

Before you begin to integrate, read the following tips.

1. Don't just do a search and replace on your existing analytics code to replace it with Localytics.

   Some other tools recommend that you tag lots of events with very little context. We'd prefer you tag only the most important events. Tag them as late as possible to increase the data we collect behind those events.

2. Don't test with the production app key.

   Test data can pollute your real data! And once data is uploaded, it can't be deleted.

3. Event names and attributes need static names.

   Dynamically generated event names and attributes will crowd your dashboard and make it difficult to find events with good data.

4. Don't tag repeating actions in loops.

   Tag events when users cause actions. If you tag an event in a loop, it will be harder to see which events are valuable.

5. Don't record binary values.

   Rather than recording a dimension or attribute with the name "logged in" and values "yes" and "no", record it as "logged in state" with values "logged in" and "logged out". That way, it's future-proofed if a third state is ever added.

6. Don't allow users to enter your app without calling .open or exit without calling .close.

   If you do, it'll cause some weirdness in session count and session lengths.

Now that you have that vital information, you can choose your platform.

The libraries were created on each platform with the following goals:

• Be as transparent as possible. This code is running in the integrator’s application and they have a right to know what it does.
• Maintain as consistent an API and integration model across platforms as possible.
• Minimize integration effort. A minimum integration should take less than 15 minutes.
• Provide enough flexibility to allow deeper integration if desired.
• Keep the design simple so it can be adapted to fit custom requirements