For the complete documentation index, see llms.txt.

Changelog

Last updated View as MarkdownSet up with AI

Opt-in to CSQ Experience Platform

Section titled Opt-in to CSQ Experience Platform

Follow these steps to switch to CSQ Experience Platform and combine Experience Analytics and Product Analytics under a single data source.

CSQ Experience Platform is currently in Early Access. To gain access, contact your Customer Success Manager.

How implementation differs for CSQ Experience Platform

Throughout the documentation, code samples use tabs to show the differences between standalone integrations and CSQ Experience Platform integrations. Your selection persists across pages.

CSQ Experience Platform docs support hint

  1. Update the SDK package to the latest version.

  2. Replace your current CSQ().start(startConfig: StartConfig.withEnvironmentId(...)) call with the dataSourceId provided by your Customer Success Manager. This links your app to the CSQ Experience Platform data source.

    await CSQ().start(startConfig: StartConfig.withDatasourceId(id: "YOUR_DATASOURCE_ID"));
  3. Review changes introduced in 4.2.0 which notably removes support for several Product Analytics options.

Build

  • Bug fix: Android builds no longer fail with AGP 9+ and built-in Kotlin, because the Kotlin Gradle Plugin is now applied only when needed.
  • Android: 1.12.2 → 1.12.3
  • iOS: 1.12.2 → 1.12.3
  • heap_flutter_bridge: 0.6.0 -> 0.7.0

WebViews

  • Bug fix: Fixed WebView Session Replay not showing Flutter content on iOS.

Build

  • Bug fix: Raised Android compileSdk to 34 and fixing host app build failures on AGP 8.13+.
  • Android: 4.51.1 → 4.52.2
  • iOS: 4.51.1 → 4.52.1

Session Replay

  • Improved stability.

Performance and Stability

  • Android: Bug fix: resolved an ANR issue and fixed a few memory leaks.
  • iOS: Bug fixes and performance improvements.

Experience Analytics

  • Improved zoning analysis and autocapture interaction performance.

Experience Analytics

  • Improved zoning analysis and autocapture interaction performance.
  • iOS: 1.11.0 → 1.11.1

Build

  • iOS: Re-signed the release artefacts with a new valid certificate to resolve a code-signing validation failure (CSSMERR_TP_CERT_REVOKED). No functional changes.

Experience Analytics

  • Bug fix: Improved zoning and heatmap stability.

Product Analytics

  • Bug fix: Fixed an error in interaction autocapture while keeping events captured correctly.
  • Bug fix: Improved interaction autocapture performance during scroll interactions.

Session Replay

  • Improved capture of small, frequently-updating custom paint animations.

Compatibility

  • Extended Flutter version support to include 3.44.4.

Build

  • Swift Package Manager (SPM) support for iOS.

WebViews

  • Bug fix: Fixed WebView tracking silently failing in apps with multiple Flutter engines.
  • Bug fix: Fixed WebView tracking not working on iOS scene-based apps.
  • Android: 1.10.1 → 1.11.0
  • iOS: 1.10.0 → 1.11.0

WebViews

  • Bug fix: Fixed Long Screenshot for views containing WebViews on Android.

Build

  • Bug fix: Repackage obfuscated Android classes to avoid R8 a.* collisions with other AARs.

Product Analytics

  • Bug fix: Event tracking: event property serialization on iOS was fixed.
  • Android: 1.5.0 → 1.10.1
  • iOS: 1.6.0 → 1.10.0

Experience Analytics

Experience Analytics: the session timeout definition changes from "30 minutes after being in background" to 30 minutes after last event. See Session definition.

Product Analytics

Product Analytics deprecation: CSQ().configureProductAnalytics() still exists, but is now deprecated in favor of CSQ().start() which combines SDK configuration and initialization in a single call:

main.dart
await CSQ().configureProductAnalytics(
environmentId: 'YOUR_ENVIRONMENT_ID',
);
await CSQ().start();
await CSQ().start(
startConfig: StartConfig.withEnvironmentId(
id: 'YOUR_ENVIRONMENT_ID',
),
);

Session Replay

Added: AnalyticsOptions.sessionReplayAutoStart — set to false to disable automatic Session Replay start and control it manually using CSQ().startSessionReplay() and CSQ().stopSessionReplay(). Defaults to true.

await CSQ().start(
startConfig: StartConfig.withEnvironmentId(
id: 'YOUR_ENVIRONMENT_ID',
options: const AnalyticsOptions(sessionReplayAutoStart: false),
),
);

Removed - Breaking: disableScreenviewForwardToDXA, disableScreenviewForwardToPA, resumePreviousSession, uploadInterval, captureVendorId, captureAdvertiserId, clearEventPropertiesOnNewUser, messageBatchMessageLimit, pruningLookBackWindow, maximumDatabaseSize, and maximumBatchCountPerUpload options have been removed. Remove them from your CSQ().start() call if present:

await CSQ().start(
startConfig: StartConfig.withEnvironmentId(
id: 'YOUR_ENVIRONMENT_ID',
options: const AnalyticsOptions(
captureVendorId: true,
captureAdvertiserId: true,
clearEventPropertiesOnNewUser: true,
messageBatchMessageLimit: 100,
resumePreviousSession: true,
pruningLookBackWindow: 6,
maximumDatabaseSize: 10000000,
maximumBatchCountPerUpload: 5,
disableScreenviewForwardToDXA: true,
disableScreenviewForwardToPA: true,
),
),
);

Session Replay

  • Session Replay fidelity was improved

Experience Analytics

  • Dialogs tracking was improved

Session Replay

  • Session Replay fidelity was improved

Performance and Stability

  • Multithread issues were fixed

Compatibility

  • Extend Flutter version support to include 3.27.0 and later (previously 3.27.4+).
  • Android: 4.43.8 → 4.44.0
  • iOS: 4.45.3 → 4.46.0

Experience Analytics

  • Introduce the Long Screenshot feature to capture and analyze long screens in the app, such as product listing pages or user profiles.

Compatibility

  • 🚨 Minimum Flutter version: Contentsquare plugin now requires Flutter SDK 3.27.4 or later
  • Android: 1.4.2 → 1.4.7

Product Analytics

  • Bug fix: Improved performance when capturing interactions on complex widget trees.

Session Replay

  • Bug fix: Fixed an issue that could cause BackdropFilter widgets to appear mispositioned in replays.

Session Replay

  • Bug fix: Fixed an issue that could cause white screens to appear on iOS.

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.