Taplytics Destination
Taplytics quick info
Taplytics accepts Track, Page, Identify, and Group calls. If you reference it in the Integrations object, call it “Taplytics”.
Taplytics accepts device-mode data from both Analytics.js and mobile sources. It does not accept data in cloud-mode.
Our Taplytics destination code is open sourced on GitHub. Feel free to check it out: iOS, Android.
Getting Started
Once the Segment library is integrated with your app, add your API key and select your settings then toggle Taplytics on in your Segment destinations. These new settings will take up to an hour to propagate to your existing users. For new users it’ll be instantaneous!
Follow the below steps for destination
iOS
To get started with Taplytics on iOS, first integrate your app with the Taplytics iOS library. To get the API key, login to your account, select the App on the top left then click into the Settings menu on the left side. If you want to set up Push Notifications click on the Push Notification tab in their UI and follow the instructions. Finally, you want to ensure you have configured your app delegate to enable push notifications.
If you want to set up deep linking, just follow this section of their docs!
For more information about setting up Taplytics on iOS, see their docs
Android
To get up and running with Taplytics on Android, there a couple of steps we will walk you through. You first want to ensure that you’ve integrated your mobile app with our Android library.
To enable its full functionality (like Push Notifications, Deep linking), there are a couple of extra steps that you have to take care of in your Android app. This document explains how to set up Push Notifications and ths one explains how to set up deep linking.
React Native set up
The Taplytics device-mode destination SDK is only available for ios in React Native.
To add the Taplytics device-mode SDK to a React Native project:
- Navigate to the root folder of your project, and run a
yarn add taplytics-ios
command to add the destination SDK to your project. - Add an
import
statement to your project, as in the example below.import Taplytics from '@segment/analytics-react-native-taplytics-ios'
- In the same project file, add the destination to the
using
list in theawait
command.await analytics.setup('YOUR_WRITE_KEY', { // Add any of your Device-mode destinations. This ensures they load before continuing. using: Taplytics // ... })
- Finally, change to your iOS development folder (
cd ios
) and runpod install
.
Identify
Use Identify to track user specific attributes. It equivalent to tracking user attributes on Taplytics. Taplytics supports traits supported by Segment as well as custom traits. If you set traits.id, we set that as the Unique ID for that user.
Track
Use track to track events and user behaviour in your app.
This will send the event to Taplytics with the associated properties. If you include a revenue
property on your Track call, we’ll call logRevenue
to pass a revenue amount into Taplytics associated with the action. If you include a value
property, we’ll map it to Taplytics amount property when we logEvent
.
Reset
If your app supports the ability for a user to logout and login with a new identity, then you’ll need to call reset in your mobile app. Here we will call Taplytic’s resetUser implementation to ensure the user information remains consistent.
Supported Sources and Connection Modes
Before you start, make sure Taplytics supports the source type and connection mode you’ve chosen to implement. You can learn more about connection modes here.
Web | Mobile | Server | |
---|---|---|---|
📱 Device-mode | ✅ | ✅ | ⬜️ |
☁️ Cloud-mode | ⬜️ | ⬜️ | ⬜️ |
This destination requires that you use a Device-based Connection Mode for Mobile data. Make sure you package the Taplytics mobile SDK with the Segment mobile library.
Settings
Segment lets you change these destination settings from the Segment app without having to touch any code.
API Key
You can find your API Key under Project Settings in the upper-left of the Taplytics interface.
Background Session Time
This will control the amount of time the app can be in background before a session is ended.
Delay Load (iOS)
Seconds to keep showing the splash screen until the experiments are loaded. Used for when running an experiment on the first page of the app.
Enable Live Update (Android)
This will automatically flag this device as a dev device and make a socket connection to the server for testing experiments and variations live.
Enable Shake Menu (Android)
This will control whether the in-app Shake Menu is enabled or not.
Enable Shake Menu (iOS)
This will control whether the in-app Shake Menu is enabled or not.
Enable Turn Menu (Android)
This is an alternative method of accessing the shake menu, useful for emulators that do not have such a capability. When enabled, turning the device three times will bring up the menu.
Push Sandbox (iOS)
Configures whether the push token for the device is a production token or if it is a development token.
This page was last modified: 23 Mar 2021
Need support?
Questions? Problems? Need more info? Contact us, and we can help!