Connect SDK overview

The Connect library captures device context and user activity such as screen views, gestures, clicks, keyboard inputs, and based on these signals, lets you deliver the right message at the right time. The data is processed and used for a wide range of customer analytics, usability reports, and replaying actual visits.

We created the Connect SDK to bring together two products that are equally important for digital marketing: the Tealeaf SDK and Campaign SDK.

How the library behaves on end users' devices

The influence on the application and user experience is insignificant.

• The Connect library adds 3 MB to the size of an iOS app and 200 KB to the size of an Android app.
• The Connect library increases memory consumption by 2-3%. If the library cannot reach the Acoustic servers, it saves the data to the device memory. By default, the cache size is limited to 512,000 bytes. Older entries get cleared as the limit is reached.
• On the average, the library transfers to the Acoustic servers about 20 KB per screen. The total amount of data depends on the number of screen views and the length of the session.
• The effect on battery life is minimal.
• The library can capture all user sessions or a random sampling. You can configure the sampling rate when generating an access key for your app.

What the library captures

Once initialized, the Connect SDK automatically logs:

• Hardware. Device type, pixel density, width and height, storage (free & used), manufacturer (for iOS devices it's always Apple Inc.).
• Software. Operating system, memory (total & remaining), interface language, IP address, app version.
• User behavior. Navigation, screenshots, gesture events, keyboard visibility, lifecycle events.
• App performance. Load time, response time, network errors, battery usage.
• Other. Device orientation, network carrier.

Requirements

To use the Connect SDK, your company must have an active Connect subscription.

• The Pro subscription supports four behavior signals: identification, add-to-cart, order, and product purchase.
• The Premium subscription supports all behavior signals and provides access to behavioral data reports.
• The Ultimate subscription supports session playback in addition to the Pro and Premium features.

General guidelines

It is important that you assign unique IDs to all UI controls that you want to capture.

Compatibility details

The Connect SDK is currently available for web apps, native iOS and Android apps as well as hybrid apps built on the Flutter and React Native frameworks.

Limitations

• Android. We do not guarantee that the current version of the library (10.4.28) is compatible with Android apps using a mixture of the Android View framework and Jetpack Compose.
• We offer limited support for iPad apps with a multi-window architecture as well as iOS apps using SwiftUI or UIScene. The library captures data from such apps and makes it available for analytics, but session replays may not work correctly.
• React Native. Only older JSC bridge architecture is supported. Expo applications are not supported unless they are ejected as native applications.

Sample apps

Before you start integrating the Connect SDK into your mobile app, we recommend building our sample app. For instructions, see Build a sample mobile app to evaluate the Connect SDK.

Integration instructions

The library works well with the default settings and requires basic configuration. Extensive customization options are available. To add the Connect library to your app, see instructions for your platform:

• Integrate the Connect SDK into your web application
• Integrate the Connect library into a native Android app
• Integrate the Connect library into a native iOS app
• Integrate the Connect library into a Flutter app
• Integrate the Connect library into your React Native app