Changelog

Already using the CSQ SDK in standalone mode? Follow these steps to switch to Unified CSQ and combine Experience Analytics and Product Analytics under a single data source.

1. Update the SDK package to 1.10.0.

2. Replace your current CSQ.start(this) or CSQ.start(this, StartConfig.withEnvironmentId(...)) call with the dataSourceId provided by your Customer Success Manager. This links your app to the Unified CSQ data source.

   CSQ.start(this, StartConfig.withDataSourceId("YOUR_DATASOURCE_ID"))

3. Review changes introduced in 1.10.0 which notably removes support for several Product Analytics options.

• Update Experience Analytics SDK version to 4.50.0:

  • The Session timeout definition changes from "30 minutes after being in background" to 30 minutes after last event. See Session definition.

• Update Product Analytics Core SDK version to 0.9.0.
• Update Product Analytics Autocapture SDK version to 0.9.0.

Configuration

API update: CSQ.start() now takes a StartConfig wrapping the environment ID and options. ProductAnalyticsOptions is renamed to AnalyticsOptions and envID to id.

CSQ.configureProductAnalytics(
  context = this,
  envId = "YOUR_ENVIRONMENT_ID",
  options = ProductAnalyticsOptions(
    enableViewAutocapture = true
  )
)

CSQ.start(this)

CSQ.start(
  context = this,
  StartConfig.withEnvironmentId(
    id = "YOUR_ENVIRONMENT_ID",
    options = AnalyticsOptions(
      enableViewAutocapture = true
    )
  )
)

Options

Added: sessionReplayAutoStart — set to false to disable automatic Session Replay start and control it manually. Defaults to true.

CSQ.start(
  context = this,
  StartConfig.withEnvironmentId(
    id = "YOUR_ENVIRONMENT_ID",
    options = AnalyticsOptions(sessionReplayAutoStart = false)
  )
)

Removed: captureVendorId, captureAdvertiserId, clearEventPropertiesOnNewUser, messageBatchMessageLimit, resumePreviousSession, pruningLookBackWindow, maximumDatabaseSize, maximumBatchCountPerUpload, disableUploadsInBackground, disableScreenviewForwardToDXA, and disableScreenviewForwardToPA are no longer available. Remove them from your CSQ.start() call if present:

CSQ.start(
  context = this,
  StartConfig.withEnvironmentId(
    id = "YOUR_ENVIRONMENT_ID",
    options = AnalyticsOptions(
      captureVendorId = true,
      captureAdvertiserId = true,
      clearEventPropertiesOnNewUser = true,
      messageBatchMessageLimit = 100,
      resumePreviousSession = true,
      pruningLookBackWindow = 6,
      maximumDatabaseSize = 200_000,
      maximumBatchCountPerUpload = 10,
      disableUploadsInBackground = true,
      disableScreenviewForwardToDXA = true,
      disableScreenviewForwardToPA = true,
    )
  )
)

APIs

Deprecated: CSQ.optIn(context: Context) — use CSQ.optIn() instead (no context parameter required).

• Update Experience Analytics SDK version to 4.44.1:

  • Analytics
    • Bug fix: Improved invisible overlay detection to resolve an issue where long screenshots were not scrollable
    • Bug fix: Fixed duplicate tap event in tracked WebViews

• Update Product Analytics Core SDK version to 0.8.9.

• Update Experience Analytics SDK version to 4.44.0:

  • Session Replay

  • Improve UI change detection to prevent unplayable screens

  • Bug fix: improve synchronisation of session between Heap and Contentsquare

  • Bug fix: resolved an internal java.util.ConcurrentModificationException

  • Bug fix: resolved an internal java.lang.NullPointerException

  • Bug fix: improve masking stability

  • Errors

    • Now setUrlMaskingPatterns can be called before the SDK start
    • OkHttp 5 compatibility with Network Plugin 1.7.0
    • Sanity checked added to URL masking patterns resolving a java.util.regex.PatternSyntaxException
    • Bug fix: validate URL patterns when setUrlMaskingPatterns is called

• Update Product Analytics Core SDK version to 0.8.8.

• Update Product Analytics Autocapture SDK version to 0.8.10.

• Update Experience Analytics SDK version to 4.43.8:
  • Errors
    • Fixed API Error URL not masked until SDK is fully initialized

• Update Experience Analytics SDK version to 4.43.7:
  • Session Replay
    • Bug fix: resolved a masking issues when multi-window is enabled

• Update Experience Analytics SDK version to 4.43.6:
  • Core
    • Bug fix: resolves crash in WindowCallbackWrapper

• Update Experience Analytics SDK version to 4.43.5:

  • Analytics

    • Add support of material ModalBottomSheetLayout for Zoning and Heatmap analysis, using the CsqTag() API

  • Core

    • Improve compatibility with DexGuard

• Update Experience Analytics SDK version to 4.43.4:

  • Session Replay

    • Bug fix: Improve memory management to avoid memory leak
    • Bug fix: Prevent crash during activity destroy process

  • Analytics

    • Bug fix: Fixed an issue where heatmap positions were not tracked correctly on some Compose screens with lazy scroll elements.
    • Bug fix: Improved invisible overlay detection to resolve an issue where long screenshots were not scrollable.

  • Core

    • Migrated from Android ContentProvider to AndroidX Startup for initialization
    • Bug fix: Resolved java.lang.NullPointerException crash on FileProvider

• Update Experience Analytics SDK version to 4.43.3:
  • Zoning Analytics
    • CsqIgnoreInteraction() now excludes wrapped Composable from the screenshot

• Update Experience Analytics SDK version to 4.43.2:

  • Session Replay

    • Bug fix: Resolved java.util.ConcurrentModificationException crash on Session Replay touch listener.

  • Analytics

    • Bug fix: Resolved java.lang.ArrayIndexOutOfBoundsException crash with Exposure Metrics.

  • Core

    • Improved SDK initialization performance by moving certain operations off the main thread

• Update Product Analytics Core SDK version to 0.8.7.
• Update Product Analytics Autocapture SDK version to 0.8.9.

• Update Experience Analytics SDK version to 4.43.0:

  • Analytics

    • Fixed an issue where screenshot button was not visible after visiting In-app settings.
    • Fixed compatibility issues with Jetpack Compose 1.10.

  • Session Replay

    • Improved gesture detection to reliably identify the targeted view.

• Update Product Analytics Core SDK version to 0.8.6.

• Webviews
  • The One WebView Tag feature is now available in controlled general availability. It brings key Product Analytics features — Identity, User Properties, Hierarchy, and Target Text — to WebViews, enabling unified Product Analytics and Experience Analytics. To gain access, contact your Customer Success Manager to be added to the eligibility list.

• Update Experience Analytics SDK version to 4.41.1:

  • Analytics

    • Fixed a crash when Jetpack Compose Node is not attached

  • Session Replay

    • Fixed a bug that cause parent masking not being propagated to child views on some scenarios
    • Improve capture of Native views inside Jetpack Compose

• Update Product Analytics Core SDK version to 0.8.5.
• Update Product Analytics Autocapture SDK version to 0.8.8.

• Update Experience Analytics SDK version to 4.41.0:
  • Analytics
    • Bug fix: Fixed an issue when the very first item of a RecyclerView is bigger than the scrollable area
  • Core
    • Bug fix: Fixed an issue when the very first item of a RecyclerView is bigger than the scrollable area

• Update Product Analytics Core SDK version to 0.8.4.
• Update Product Analytics Autocapture SDK version to 0.8.7.

• Update Experience Analytics SDK version to 4.40.0:
  • Session Replay
    • Image and Text masking configuration in the CSQ Console
    • Added new APIs to start Session Replay on demand
    • Added new APIs to support Event-Triggered Replays
  • Analytics
    • Bug fix: Fixed a potential crash when generating scroll metrics on certain Compose screens
    • Improve heatmap data accuracy for Compose lazy lists and grids

• Update Product Analytics Core SDK version to 0.8.3.
• Update Product Analytics Autocapture SDK version to 0.8.6.

• Update Experience Analytics SDK version to 4.39.3:
  • Session Replay
    • Bug fix: Fix blank screens in Jetpack Compose when the dialogs and bottom sheets capture was enabled.
    • Bug fix: Fixed an issue causing an inconsistent Tag injection for Webviews in Capacitor apps.
    • Bug fix: Fixed an issue causing unreliable Session Replay starts in Capacitor apps.
    • Improved Session Replay screen change consistency on Capacitor apps

Initial release of the CSQ SDK.

• Introduces the unified CSQ API, which combines Product Analytics, Experience Analytics, and Monitoring features into a single, cohesive library.
• This initial release includes:
  • Experience Analytics SDK version 4.39.2.
  • Product Analytics Core SDK version 0.8.2.
  • Product Analytics Autocapture SDK version 0.8.3.