This guide is meant to walk you through the Taplytics initialization.
Once you've completed the steps in this guide you will be able to use the Taplytics Dashboard to do things like, create a simple visual experiment and send a simple push.
We suggest implementing this guide one step at a time as it's the best way to familiarize yourself with the Taplytics platform.
1. Install the SDK
Please follow the steps outlined in the implementation guides linked below.
If you've set up the SDK correctly, you'll see the Taplytics Dashboard which looks like this:
If you are still seeing the screen below and have installed the SDK correctly, please reach out to us and we will get you sorted out.
2. Configuration Start Options
Start options allow you to control how certain SDK features function; you can enable or disable these features as you need
3. Setting User Attributes
Setting user attributes allows you to customize how you segment your users on a very granular level. We recommend at least setting a unique userID to track your users.
Note: User Attributes set before
startTaplyticsAPIKey: is called, will be used for experiment segmentation on the first session of your app.
Any attributes that are set after
startTaplyticsAPIKey: is called will not be used for experiment segmentation until the next session of your app.
4. Pairing your phone with Taplytics
There are a few reasons you'd want to ensure that Advanced Pairing and pairing in general works on your device.
First, it's the only way to use the visual editor which is a great way to start experiments that don't require any code to set up. Second, it's an easy way to load code variables onto the Taplytics dashboard for use in experiments.
We recommend setting up advanced pairing when installing the SDK to allow for more flexibility of users being able to pair when they need to.
How to set up Advanced Pairing
5. Logging Events
The below events and general information are automatically tracked by Taplytics and will appear on your dashboard. If you already have third party analytics events instrumented with another Analytics source Taplytics will pull in the events for your use. You can also create your own Taplytics Events if you need.
- Automatic Tracking - iOS events
- Automatic Tracking - Android events
- Taplytics Events - iOS
- Taplytics Events - Android
- Track Events - Web
6. Variables and Code Blocks
Taplytics offers a code-based solution to run experiments on your project. You can implement these via the Taplytics Dashboard and push them to your code and begin to use them for experiment creation.
Similar to Dynamic Variables, Taplytics has an option for 'Code Blocks'. Code blocks are linked to Experiments through the Taplytics website very much the same way that Dynamic Variables are, and will be executed based on the configuration of the experiment through the Taplytics website. A Code Block is a callback that can be enabled or disabled depending on the variation. If enabled, the code within the callback will be executed. If disabled, the variation will not get the callback.
7. Quick QA
To see which variations and experiments are running on a given device, there exists a
getRunningExperimentsAndVariations() function which provides a callback with the current experiments and their running variation. An example:
- getRunningExperimentsAndVariations - iOS
- getRunningExperimentsAndVariations - Android
- runningExperiments - Web
When using synchronous variables in experiments it is useful to ensure that the experiment variation is loaded before using the variable. This can be done using the
propertiesLoadedCallback: method -
You can also retrieve information about specific sessions using the following methods:
8. Other Useful Options
Taplytics has a few other opinions for users that might be helpful as you get starting using the SDK.
1. User Opt In / Opt Out - Useful to get user consent for analytics tracking
2. Taplytics has the option to delay the loading of your main activity while Taplytics gets initial view changes ready. Keep in mind that this initial load will only take some time the very first time, after that, these changes will be saved to disk and will likely not need a delay.
3. To manually force a new user session (ex: A user has logged in / out), there exists
Taplytics.startNewSession. If there is an internet connection, a new session will be created, and new experiments/variations will be fetched from Taplytics if they exist.