SDK API reference

The SDK API provides the following methods with their signatures, parameters, and usage examples.

Get user consent.
Calling this API generates a user ID and initiates tracking.

Call optIn after start.

CSQ.optIn(Context)

• Context   object  

  Android Context object ↗

Revoke user consent, remove stored userId.
Stop CSQ SDK, flush, and clear all data.

CSQ.optOut()

• Context   object  

  Android Context object ↗

Assigns an identity to be associated with the current user.

This assigns the identity to all events for the user ID and lets the analysis module merge multiple user IDs with the same identity.

CSQ.identify(identity: String)

• identity   String (<= 100 chars)  

  Identity to be associated with the current user.

If the user was previously identified with identify(), this creates a new unidentified user and session. This is technically equivalent to calling optOut() then optIn().

CSQ.resetIdentity()

No parameters.

Associate a user identifier to the session.

CSQ.sendUserIdentifier(identity: String)

• identity   String (<= 100 chars)  

  The string value representing the user identifier to be associated with the current session. Should be max 100 characters long.

Get all the information related to the user and project.

Identifier of the current user. This is an identifier from Product Analytics by default or Experience Analytics if Product Analytics is not active.

CSQ.metadata.userId

Session identifier. This is an identifier from Experience Analytics by default or Product Analytics if Experience Analytics is not active.

CSQ.metadata.sessionId

Project identifier for Experience Analytics.

CSQ.metadata.projectId

Environment identifier for Product Analytics.

CSQ.metadata.environmentId

URL of current Session Replay.

CSQ.metadata.sessionReplayUrl

Identity associated with the user by calling identify().

CSQ.metadata.identity

A block triggered each time user information is updated. For example when sessionReplayUrl becomes available or userId updates. Set this block to subscribe to the updates. Contentsquare will call this block with updated metadata.

CSQ.metadata.onChanged = OnMetadataChanged { metadata ->
    // Handle information change
}

• metadata   Metadata  

  Metadata associated with the current user and project.

Sets the current log level.

CSQ.debug.logLevel = loglevel

• level   Enum (CSQ.Log.Level)  

  Possible values: none, trace, debug, info, warn or error.

Add a LogChannel to which send log messages.

CSQ.debug.logChannel = channel

• LogChannel   interface  

  The interface where log messages will be routed.

Routes SDK logs to another location such as Timber, Arbor, or similar logging libraries. The default implementation routes all logs through Logcat.

LogChannel.printLog()

No parameters.

Experience Analytics | Ajouté à la version : 1.0.0

Adds one or multiple dynamic variables to the session properties. This method allows you to pass a DynamicVar object, representing a key-value pair that is scoped to the session.

val var1 = DynamicVar("key1", "value1")
val var2 = DynamicVar("key2", 10L)
CSQ.addDynamicVar(var1)
CSQ.addDynamicVar(var2)

• DynamicVar   object  

  The dynamic variable

  key   String (<= 512 chars)  

  Dynamic variable key

  value   String/Long  

  Dynamic variable value

Product Analytics | Ajouté à la version : 1.0.0

Add a collection of properties to be associated with the current user.

CSQ.addUserProperties(properties: Map<String, Any>)

• properties   Map<String, Any>  

  A map of user properties.

Product Analytics | Ajouté à la version : 1.0.0

Add a collection of properties to be associated with all future events.

CSQ.addEventProperties(properties: Map<String, Any>)

• properties   Map<String, Any>  

  A map of event properties.

  key   String  

  the UserProperty key

  value   Any  

  values can be any combination of any Number, Boolean, String or Java/Kotlin object that implements Property

Product Analytics | Ajouté à la version : 1.0.0

Removes a single property from the collection of event-wide properties.

CSQ.removeEventProperty(property: String)

• property   String  

  The key of the property to remove.

Product Analytics | Ajouté à la version : 1.0.0

Removes all event-wide properties.

CSQ.clearEventProperties()

Experience Analytics | Ajouté à la version : 1.0.0

Exclude a scrollable view or subclass from Exposure Metric computations.

CSQ.excludeFromExposureMetric(View)

• View   View  

  The view to exclude from exposure metrics.

Experience Analytics | Ajouté à la version : 1.4.4

Jetpack Compose composable function for tagging composables that require special handling by SDK. It is currently used to enable support for material ModalBottomSheetLayout in Zoning and Heatmap analysis.

enum class CsqTag {
  ModalBottomSheetLayout
}

@Composable
fun CsqTag(tag: CsqTag, block: @Composable () -> Unit)

• tag   Enum (CsqTag)  

  indicates the type of special handling required by the SDK

  CsqTag.ModalBottomSheetLayout - enables the SDK to properly capture and analyze content within a material ModalBottomSheetLayout for Zoning and Heatmaps.

• block   @Composable () -> Unit  

  the composable lambda representing the UI content to be tagged

Register a webview for tracking.

CSQ.registerWebView(webView)

• webView   WebView  

  The webview to register for tracking.

Unregister a webview for tracking.

CSQ.unregisterWebView(webView)

• webView   WebView  

  The webview to unregister from tracking.

Experience Analytics | Ajouté à la version : 1.0.0

Send a transaction.

CSQ.trackTransaction(Transaction)

• Transaction   Transaction  

  The transaction object to be sent.

Send a screen view with or without custom variables.

CSQ.trackScreenview(name: String, cvars: List<CustomVar> = emptyList())

• name   String  

  The name of the screen.

• cvars   List<CustomVar> (optional)  

  A list of custom variables to attach to the screen view.

  index   Int (@IntRange(from = 0, to = 20))  

  A number identifying a CustomVar

  name   String (<= 512 chars)  

  Custom variable key

  value   String  

  Custom variable value

Product Analytics | Ajouté à la version : 1.0.0

Creates an event message to be tracked and sent to the API.

CSQ.trackEvent(name: String, properties: Map<String, Any> = mapOf())

• name   String  

  The name of the event to be tracked.

• properties   Map<String, Any> (optional)  

  Optional properties to associate with the event.

Experience Analytics | Ajouté à la version : 1.0.0

Track a gesture manually.

CSQ.trackMotionEvent(motionEvent: MotionEvent)

• motionEvent   MotionEvent  

  The MotionEvent ↗ to be tracked.

Experience Analytics | Ajouté à la version : 1.0.0

Helper function for Jetpack Compose to ensure only one screen view is triggered when a given screen is presented to the user.

@Composable
TriggeredOnResume(block: () -> Unit)

• block   Function  

  The block of code to run when the screen is resumed.

Experience Analytics Voice of Customer | Ajouté à la version : 1.0.0

Triggers a survey by referencing a predefined trigger name.

This method allows your mobile app to trigger surveys at specific moments in the user journey. Triggers act as flexible placeholders that are not bound to individual surveys, enabling your business team to assign or update surveys later without requiring code changes.

CSQ.triggerSurvey(triggerName: String)

• triggerName   String  

  The name of the trigger associated with the survey. This should match the trigger name configured in the Contentsquare platform.

// Trigger a survey after a purchase is completed
CSQ.triggerSurvey("purchase-complete")

Experience Analytics | Ajouté à la version : 1.0.0

Sets URL masking patterns.

CSQ.setUrlMaskingPatterns(patterns: List<String>)

• patterns   List<String>  

  A list of URL patterns to mask.

Experience Analytics | Ajouté à la version : 1.0.0

Track network metrics.

CSQ.trackNetworkMetric(networkMetric: NetworkMetric)

• networkMetric   NetworkMetric  

  The network metric to be tracked.

Experience Analytics | Ajouté à la version : 1.0.0

Intercept every OkHttp call to manually collect API errors.

val okhttpClient = OkHttpClient().newBuilder()
        .addInterceptor(CsqOkHttpInterceptor())
        .build()

Ignore interactions for a specific view.

CSQ.ignoreInteractions(view: View)

Kotlin extension function to ignore interactions for a specific view.

View.csqIgnoreInteractions()

Jetpack Compose composable function to ignore interactions for a specific view.

@Composable
fun CsqIgnoreInteraction(ignore: Boolean, block: @Composable () -> Unit)

• ignore   Boolean  

  indicating whether interactions should be ignored or not

• block   @Composable () -> Unit  

  composable lambda function representing the UI content to apply ignore condition

Experience Analytics | Ajouté à la version : 1.0.0

Set the default masking state.
All Android View elements, their subclasses and Jetpack Compose components are fully masked by default.

CSQ.setDefaultMasking(masked: Boolean)

• masked   Boolean  

  The masking state to be set.

Mask a view's content.

CSQ.mask(view: View)

• View   View  

  The view which content will be masked.

Kotlin extension function to mask the content of a view.

View.csqMaskContents(enable: Boolean)

• enable   Boolean  

  Whether to mask the content of the view.

Jetpack Compose composable function that applies masking to Compose UI content This will mask both Session Replay and analytics event..

@Composable
CsqMask(enable: Boolean, block: @Composable () -> Unit)

• enable   Boolean  

  Whether to mask the content of the view.

• block   @Composable () -> Unit  

  composable lambda function representing the content to apply masking condition

Unmask a view's content.

CSQ.unmask(view: View)

• View   View  

  The view whose content will be unmasked.

Experience Analytics | Ajouté à la version : 1.0.0

Mask content for views of a specific type.

CSQ.mask(type: Class<*>)

• type   Class<?>  

  The class type of the view whose content will be masked.

Experience Analytics | Ajouté à la version : 1.0.0

Unmask content for views of a specific type.

CSQ.unmask(type: Class<*>)

• type   Class<?>  

  The class type of the view whose content will be unmasked.

Mask text input fields.

CSQ.maskTexts(mask: Boolean)

• mask   Boolean  

  Whether to mask text.

Deprecated Product Analytics | Ajouté à la version : 1.0.0

SDK configuration method for Product Analytics. Use CSQ.start() instead, which combines configuration and initialization in a single call.

Start the SDK. This method combines configuration and initialization in a single call.

There are three overloads depending on whether you want Experience Analytics, Product Analytics, or Unified CSQ.

Experience Analytics only:

CSQ.start(context = this)

Product Analytics (optionally with Experience Analytics extension) with environmentId:

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

Unified CSQ with dataSourceId:

CSQ.start(
  context = this,
  StartConfig.withDataSourceId(
    id = "YOUR_DATASOURCE_ID"
  )
)

• context   Context  

  Android Context object ↗

• startConfig   StartConfig (optional)  

  Configuration created via StartConfig.withEnvironmentId(id, options) or StartConfig.withDataSourceId(id, options). Omit for Experience Analytics only.

Stop all activity from the SDK.
Once run no requests, telemetry collection, or logs will be generated.

CSQ.stop()

Pause all tracking features.

CSQ.pauseTracking()

Resume all tracking features.

CSQ.resumeTracking()

CSQ SDK options passed to CSQ.start().

// optional: StartConfig.withEnvironmentId(id: String, options) | StartConfig.withDataSourceId(id: String)
CSQ.start(
  context = this,
  StartConfig.withEnvironmentId(
    id = "YOUR_ENVIRONMENT_ID",
    options = AnalyticsOptions(
      enableViewAutocapture = true,
      baseUri = URI.create("https://example.com/"),
      uploadInterval = 15.0,
      disablePageviewAutocapture = false,
      enablePushNotificationAutocapture = true,
      enablePushNotificationTitleAutocapture = true,
      enablePushNotificationBodyAutocapture = false,
      sessionReplayAutoStart = false
    )
  )
)

URI object specifying the base URI for the desired API endpoint. The CSQ SDK resolves paths using this base URI and ignores any pre-existing path elements.

Interval in seconds at which event batches are uploaded to the API. Defaults to 15 seconds.

Whether source pageview events will be auto-captured. Defaults to false.

Whether the SDK will auto capture UI interactions and source pageviews. Only for Android View system, no Compose support. Defaults to false.

Whether the SDK will auto capture interaction events on notifications. Defaults to false.

Whether capture the title of the notification where an interaction was performed. enablePushNotificationAutocapture must be set to true. Defaults to false.

Whether capture the body text of the notification where an interaction was performed. enablePushNotificationAutocapture must be set to true. Defaults to false.

Whether Session Replay starts automatically at SDK launch. Defaults to true.

Set to false to disable automatic start and control Session Replay manually.