Help

Microsoft Clarity

Microsoft Clarity is a free behavioral analytics tool that helps retailers understand how users interact with their app through session replays and heatmaps. It automatically captures interactions such as taps, scrolls, and navigation flows, without the need for manual event tagging.

To integrate Microsoft Clarity into your application, follow these steps:

  1. Include the Clarity PoqSDK in your build.gradle: 
    implementation("com.poqstudio:analytics.clarity:$poqSdkVersion")
  2. Provide your Clarity project ID through the ClaritySettings object.

Poq Settings

The Clarity PoqSDK is configurable via ClaritySettings. Through ClaritySettings you can configure:

  • projectId: Clarity project ID.

The Clarity project ID can be found on the Settings page of your Clarity dashboard.

Clarity only starts recording once the user has granted tracking consent. The SDK observes the shared user tracking-consent decision and:

  • initialises Clarity the first time consent is granted,
  • pauses recording if consent is later revoked, and resumes it if it is granted again.

If consent is declined, Clarity is never initialised. Consent is captured through the Privacy Settings screen, which is shown automatically on first launch and can also be opened with the ://privacy-settings deep link.