For the complete documentation index, see llms.txt.

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.

Unified CSQ guidance

Throughout the documentation, code samples highlight differences between standalone and Unified CSQ integrations.

Unified CSQ docs support hint

  1. Update the SDK package to 1.10.0.

  2. Replace your current CSQ.start() or CSQ.start(environmentID:) call with the dataSourceID provided by your Customer Success Manager. This links your app to the Unified CSQ data source.

    AppDelegate.swift
    CSQ.start(dataSourceID: "YOUR_DATASOURCE_ID")
  3. Review changes introduced in 1.10.0 which notably removes support for several Product Analytics options.

Experience Analytics
  • 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.
Product Analytics
  • Update Product Analytics Autocapture SDK version to 0.11.0
  • Update Product Analytics Core SDK version to 0.9.0
  • Update Product Analytics Notification SDK version to 0.9.0

Configuration

API update: CSQ.configureProductAnalytics() is now deprecated in favor of use CSQ.start() which combines SDK configuration and initialization in a single call:

AppDelegate.swift
CSQ.configureProductAnalytics(
environmentID: "YOUR_ENVIRONMENT_ID",
additionalOptions: [
// ...
]
)
CSQ.start()
CSQ.start(
environmentID: "YOUR_ENVIRONMENT_ID",
options: [
// ...
]
)

Options

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

CSQ.start(
environmentID: "YOUR_ENVIRONMENT_ID",
options: [
.sessionReplayAutoStart: false
]
)

Renamed: .enableUIKitAutocapture is now .enableNativeAutocapture:

CSQ.start(
environmentID: "YOUR_ENVIRONMENT_ID",
options: [
.enableUIKitAutocapture: true,
.enableNativeAutocapture: true,
]
)

Removed: .captureVendorID, .captureAdvertiserID, .clearEventPropertiesOnNewUser, .messageBatchByteLimit, .messageBatchMessageLimit, .resumePreviousSession, .pruningLookBackWindow, .disableScreenviewForwardToDXA, .disableScreenviewForwardToPA, .interactionHierarchyCaptureLimit, .disableInteractionTextCapture, and .disableInteractionAccessibilityLabelCapture are no longer available. Remove them from your CSQ.start() call if present:

CSQ.start(
environmentID: "YOUR_ENVIRONMENT_ID",
options: [
.captureVendorID: true,
.captureAdvertiserID: true,
.clearEventPropertiesOnNewUser: true,
.messageBatchByteLimit: 200_000,
.messageBatchMessageLimit: 100,
.resumePreviousSession: true,
.pruningLookBackWindow: 6,
.disableScreenviewForwardToDXA: true,
.disableScreenviewForwardToPA: true,
.interactionHierarchyCaptureLimit: 5,
.disableInteractionTextCapture: true,
.disableInteractionAccessibilityLabelCapture: true,
]
)
Experience Analytics
  • Update Experience Analytics SDK version to 4.46.3:

    Session Replay

    • Improved performance of view hierarchy processing, reducing CPU usage.
    • Fixed a threading issue that could cause occasional crashes.
    • Fixed an issue where some images could be missing in replays.

    Analytics

    • Improved runtime stability

    Errors

    • Enhanced tracking of initial crashes after application installation.
Experience Analytics
  • Update Experience Analytics SDK version to 4.46.2:

    Session Replay

    • Fixed a crash related to SVG images when harmonized masking is enabled

    Analytics

    • Fixed an issue where a screenshot capture would cause the app to become unresponsive
Experience Analytics
  • Update Experience Analytics SDK version to 4.46.1:

    Analytics

    • Zoning / Heatmap: Add support for SwiftUI drawingGroup

    Session Replay

    • Fix a protobuf serialization crash
    • Fix a crash related to NSAttributedString encoding
Experience Analytics
  • Update Experience Analytics SDK version to 4.46.0:

    Session Replay

    • Improved session synchronization between Session Replay and Product Analytics
    • Enhance playback reliability when using stopTracking() followed by resumeTracking()
    • Strengthen playback stability when optOut() is triggered
    • Fix nil replay link when callback is subscribed before start()
    • Enhance stability when using csMasking SwiftUI modifier
    • Improve robustness against race conditions involving weak SwiftUI component references
    • Optimize handling of collections with unusually long durations

    Errors

    • Improve API error handling by ensuring URLs remain visible when invalid masking patterns are provided via ErrorAnalysis.setURLMaskingPatterns()

    Analytics

    • Improved Zoning metrics accuracy for some custom SwiftUI components
    • Fixed an issue where a screenshot captures would fail for React Native applications
Product Analytics
  • Update Product Analytics Notification SDK version to 0.8.3
Experience Analytics
  • Update Experience Analytics SDK version to 4.45.6:

    Session Replay

    • Fix a crash due to infinite recursion when a sublayer references the parent view as delegate (issue observed in CorePlot)
Experience Analytics
  • Update Experience Analytics SDK version to 4.45.5:
Experience Analytics
  • Update Experience Analytics SDK version to 4.45.4:
Experience Analytics
  • Update Experience Analytics SDK version to 4.45.3
Product Analytics
  • Update Product Analytics Autocapture SDK version to 0.10.1
  • Update Product Analytics Core SDK version to 0.8.8:
  • Update Product Analytics Notification SDK version to 0.8.1:
Experience Analytics
  • Update Experience Analytics SDK version to 4.45.1:
Experience Analytics
  • Update Experience Analytics SDK version to 4.45.0:

Analytics

  • Fixed a crash related to Zoning and Heatmap data collection on iOS 26 devices

Session Replay

  • Fixed a crash related to gesture capture on iOS 26 devices
  • Fixed an issue where the background color of an Image wouldn’t be correctly rendered
  • Fixed a protobuf serialization crash on iOS 26 devices
  • Performance improvement on iOS 26 devices
Experience Analytics
  • Update Experience Analytics SDK version to 4.44.3:

    Session Replay

    • Fixed a rare crash related to gesture.
Experience Analytics
  • Update Experience Analytics SDK version to 4.44.2:

    Session Replay

    • Fixed a crash related to AVPlayerViewController.
Product Analytics
  • Update Product Analytics Autocapture SDK version to 0.9.1:
    • Fixed a crash when calling AttributedString(localized:) with an interpolated string.
    • Taps inside WKWebView are now ignored by default because they don't contain meaningful data and produce noise when integrating with tag capture. To restore capture on a specific view, use webView.heapIgnoreInteractions = false.

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.

Experience Analytics
  • Update Experience Analytics SDK version to 4.44.1:

    Core SDK

    • Fix an issue with the SDK internal Codable conformance extension for NSTextAlignment.

    Analytics

    • Heatmaps: Fix an issue where some taps would be inaccurate on iOS 26 devices
Experience Analytics
  • Update Experience Analytics SDK version to 4.44.0:

    Analytics

    • Improved iOS 26 support for Zoning and Heatmap analysis
    • ⚠️ Starting with iOS 26: Reliable targets are compatible with UIKit accessibilityIdentifier only. Read more at Reliable targets
    • Improved data collection on segmented controls

    Session Replay

    • Improved iOS 26 support to display correctly text and images on SwiftUI views for apps built with Xcode 26
    • Fix a crash related to bitmap rendering
Product Analytics
  • Update Product Analytics Core SDK version to 0.8.7:
    • SDK is now built with Xcode 16.0.
    • Internal improvements for autocapture.
Experience Analytics
  • Update Experience Analytics SDK version to 4.43.3:

    Session Replay

    • Fixed a bug where gradient backgrounds were not properly collected for React Native

    Analytics

    • Heatmaps: Fixed a crash related to frame computations
Product Analytics
  • Update Product Analytics Autocapture SDK version to 0.9.0:
    • SwiftUI Autocapture
      • Our Autocapture SDK now includes support for SwiftUI
Experience Analytics
  • Update Experience Analytics SDK version to 4.43.2:

    • Core SDK

      • Improved internal feature flag stability
    • Session Replay

      • Fixed an issue where SwiftUI images were missing from the replay on iOS 26 devices.
Experience Analytics
  • Update Experience Analytics SDK version to 4.43.0:
    • Session Replay
      • Image/Text masking configuration in the CSQ Console
      • Support Event Triggered Replay
Experience Analytics
  • Update Experience Analytics SDK version to 4.42.4:
    • Session Replay
      • Fix an issue related to CSInApp on iPad
      • Support for React Native New Architecture Text
      • Improved Session Replay screen change consistency on Capacitor apps
    • WebView
      • Fix an issue related to config

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.42.1.
    • Product Analytics Core SDK version 0.8.6.
    • Product Analytics Autocapture SDK version 0.8.0.
    • Product Analytics Notification Autocapture SDK version 0.8.0.