Skip to main content

Get started

Product Analytics reads the behavioral events your Real User Monitoring SDK already sends. Once RUM is instrumented and Product Analytics is enabled for your team, it populates automatically—there's no second SDK to install.

This page covers what you need before you start, the data model behind funnels and heatmaps, and the permissions that control access.

What you need

Minimum SDK versions required for Product Analytics. Heatmaps are available for web applications only; funnels and pathways work with all SDKs.

SDKMinimum version
Browser3.21.0
Android2.17.1
iOS2.10.4
React Native0.8.0
Flutter0.10.2

The data model

Product Analytics is built on three event types that the RUM SDK captures as users interact with your application:

  • Session. A single user journey through your application, from the first activity until the user leaves or becomes inactive. A session groups the views and actions that belong to one visit.
  • View. A page or screen the user lands on, identified by its path—for example, /dashboard or /explore. Views are the navigation backbone of a funnel.
  • Action. A discrete interaction within a view, such as a click on a button or link—for example, click on create.

Funnels are defined as an ordered sequence of view, action, and custom events. Heatmaps aggregate action events by the element the user interacted with. Pathways trace the sequences of views users move through before or after a chosen view. Because every event carries its session context, you can move from an aggregate metric to the individual sessions behind it.

Name your clickable elements

Product Analytics identifies each action by the element the user interacted with, so give your clickable elements stable, meaningful names—add an aria-label or a data-cx-action-name="your-element-name" attribute. Explicit names let Product Analytics identify and categorize interactions accurately instead of relying on unstable signals such as visible text, DOM structure, or CSS classes. Consistent labeling improves event quality, makes heatmaps and funnels easier to understand, and keeps your analytics dependable as the interface evolves. An element with no usable name appears as Unnamed element.

Open Product Analytics

Product Analytics is a top-level item in the left navigation, alongside RUM and Infrastructure. Opening it takes you to the Heatmaps view by default, with Funnels and Pathways available alongside it. Each view has a time range picker that scopes the analysis to a period.

Product Analytics open to the Heatmaps view, with the Product Analytics menu listing Heatmaps, Funnels, and Pathways

Permissions

Access to Product Analytics is controlled by two permission keys. Assign them through your role and policy configuration.

PermissionGrants
PRODUCT-ANALYTICS:READView Product Analytics—including heatmaps and building ad-hoc funnels
PRODUCT-ANALYTICS:MANAGESave, rename, and delete funnels

Next steps

See where users click and scroll on a page: Heatmaps.

Last updated on