Tracking snippet, identities and events
Install the script, configure consent and collect page, route, click, form, scroll and heartbeat activity.
Guides in this workflow
Follow the guide that matches the exact action, filter, menu change or issue.
Open the tracking snippet
Copy the generated async/defer script and required data attributes.
Install the tracking snippet on a website
Place the script before the closing head tag or in the approved global template.
Configure the data-site attribute
Use the exact site key registered by the module.
Configure the data-endpoint attribute
Use the generated collector endpoint when tracking outside the CRM host.
Use explicit granted consent
Set data-consent="granted" only where the site’s consent process authorises collection.
Use runtime-required consent
Omit granted consent or integrate the script with the site consent process where required.
Use the data-respect-dnt attribute
Match the script attribute to the configured privacy policy.
Set visitor identity type
Use data-user-type to classify website visitor, client or other supported context.
Set a visitor label
Use data-user-label for a readable identity label where appropriate.
Set the access-area attribute
Use data-access-area to identify website, admin, client or another embedded context.
Understand page-view tracking
The script records initial and supported navigation page views.
Track single-page application routes
The script observes supported history/navigation changes.
Understand click-event tracking
The script records supported click metadata, not arbitrary page content.
Understand form-submission metadata
The script records form submission metadata while avoiding unsupported field-content capture.
Understand scroll-depth tracking
The script records milestone depth events.
Understand session heartbeat pings
Periodic pings keep the visitor session active.
Understand event batching
The browser batches events and uses sendBeacon or fetch with keepalive where available.
Understand disabled mouse-movement capture
The supplied script does not stream mouse movement.
Verify the tracking script
Load a controlled page and confirm collect/ping responses and a visible session.