Skip to main content
The web addon provides automatic pageview tracking, engagement measurement, and standard event capture. This is the recommended way to track user activity.

Web Addon

Page Properties

SPA Support

Web Addon

The web addon automatically tracks:
  • Pageview - When a page loads
  • PageviewEngagement - Periodic engagement signals
  • PageviewComplete - When user leaves the page
  • FormSubmission - When forms are submitted
  • LinkClick - When links are clicked

Basic Setup

This single call enables all automatic tracking features.

With Page Properties

Page Properties

Page properties provide context about the content and are included in Pageview events.

Standard Properties

Article Properties

Video Properties

Homepage

Section Page

Automatic Events

Pageview Event

Fired immediately when addon('web') is called:

PageviewEngagement Event

Fired periodically while the user is on the page:

PageviewComplete Event

Fired when the user leaves the page:

FormSubmission Event

Fired when a form is submitted:
Sensitive fields (password, credit card, etc.) are automatically excluded from FormSubmission events.

LinkClick Event

Fired for outbound link clicks:

Engagement Configuration

Engagement Interval

Control how often PageviewEngagement events fire:

Custom Engagement Detection

Override the default engagement detection:

Custom Completion Logic

Override the default scroll completion calculation:

Context Override

Override automatic context detection:

SPA Support

For Single Page Applications (React, Vue, Angular), call permutive.addon('web', {...}) on navigation to track a new Pageview:

Basic SPA Pattern

React Integration

Vue Integration

Angular Integration

Infinite Scroll

For infinite scroll pages, track additional content loads:

Filtering Events

Filter which events are tracked:

Debugging

Enable debug mode to see pageview tracking in action:
Console output:

Troubleshooting

Problem: No Pageview event in debug output.Solutions:
  • Verify permutive.addon('web', {...}) is called
  • Check that consent is granted (if consentRequired: true)
  • Ensure SDK is loaded before addon call
  • Look for JavaScript errors in console
Problem: No PageviewEngagement events.Solutions:
  • Check eventInterval isn’t set too high
  • Verify user is actively engaging (scroll, mouse move)
  • Ensure page stays open long enough
  • Test with debug mode enabled
Problem: Only first pageview tracked in SPA.Solutions:
  • Call permutive.addon('web', { page: {...} }) on each route change
  • Verify the addon call receives updated page properties
  • Check that router events are firing correctly
Problem: Multiple Pageview events per page.Solutions:
  • Ensure addon('web') called only once
  • Check for multiple SDK initializations
  • Verify not calling both addon and track manually

Event Tracking

Track custom events

Event Properties

Structure event data

Contextual Data

Page-based targeting

Video Tracking

Track video content