Track push notifications

After completing the setup process you will be able to:

  • Automatically track interactions on your mobile notifications
  • Define and analyze notification interaction events in Contentsquare

Installing Notification Autocapture

Section titled Installing Notification Autocapture

Notification autocapture is included in the CSQ SDK.

You only need to install the Heap Gradle Plugin using version 1.1.0 or later:

build.gradle.kts
plugins {
// ...
id("io.heap.gradle") version "1.1.0"
}

Initializing Notification Autocapture

Section titled Initializing Notification Autocapture

Notification autocapture can be initialized with enablePushNotificationAutocapture: true in CSQ.configureProductAnalytics().

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

Capture the title or body text of the notification where an interaction was performed using enablePushNotificationTitleAutocapture and enablePushNotificationBodyAutocapture.

CSQ.configureProductAnalytics(
context = this,
envId = "YOUR_ENVIRONMENT_ID",
options = ProductAnalyticsOptions(
enablePushNotificationAutocapture = true,
enablePushNotificationTitleAutocapture = true
enablePushNotificationBodyAutocapture = true
)
)

Once registered, Contentsquare will begin collecting interaction events on notifications.

With notification data flowing, you’ll want to jump into Product Analytics and start defining notification interaction events. These events will show up as a special “Notification Interaction” event type in Product Analytics and have several properties available to create definitions:

  • Notification Title: The title text of the notification. Capture can be enabled/disabled via a config option as described above.
  • Notification Body: The body text of the notification. Capture can be enabled/disabled via a config option as described above.
  • Notification Action: The text of the notification action that was interacted with, if any.
  • Notification Source: What caused the notification to fire. This could be a push service, a geofence, or unknown.
  • Notification Handling Component: The name of the component in code that handled the notification interaction.
  • Notification Category: This is the notification channel that the notification was delivered to. This typically denotes the type of notification that with which the interaction occurred.