SDKs
Help centerCommunityDevelopersAcademyStatus

Connect SDK overview

Suggest Edits

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

The library gets the following details about end users' devices:

  • 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.
  • Other. Device orientation, network carrier.

Requirements

To use the Connect SDK, your company must have an active Connect subscription of the Premium or Ultimate level.

  • The Premium subscription provides access to behavioral data reports.
  • The Ultimate subscription supports session playback in addition to the reports.

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.

For web apps, we offer a JavaScript library. You can integrate it into any web application as long as it uses standard HTTP and HTTPs protocols.

  • Development environment. To integrate the SDK into a native Android app, you need Android Studio.

📘

Update

Starting from version 10.4.28 released in December 2024, the Connect Android library has been compatible with Android apps built in Jetpack Compose.

  • Mobile app compatibility. The library can capture user experience data on end users' devices running Android 5.0 (API level 21) or later.
  • Development environment. You can integrate the Connect SDK into native iOS applications build on Swift/SwiftUI and Objective-C. You will need Xcode 15 or later with Command Line Tools.
  • Mobile app compatibility. The library can capture user experience data on end users' devices running iOS 13 and later. On iPadOS, only single-window applications are fully supported.
  • Development environment. To integrate the SDK into your app, you need a standard Flutter environment. Supported versions: 3.16 and later.
  • Mobile app compatibility. The library can function on end users' devices running Android 5.0 (API level 21) - Android 14 (API level 34). Supported iOS versions - 13.0 and later.
  • Development environment. To integrate the SDK into your app, you need a standard React Native environment. Supported versions: 0.72.6 and later.
  • Mobile app compatibility. The library can function on end users' devices running Android 5.0 (API level 21) - Android 14 (API level 34). Supported iOS versions - 13.0 and later.

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:

Updated 2 days ago