Skip to main content

Advanced DOM Pixel Events API

Anchor to heatmaps-and-session-recordingsFor apps providing session recording and/or heatmaps

The Advanced DOM Events API provides events that replicate the DOM, changes to the DOM and user interactions. It can be used to recreate user journeys and interactions for session recording and/or heatmaps. The API provides these events across the Storefront, Checkout, Thank you page and Customer Accounts pages.

Shopify Plus

These events are limited on checkout to stores on the Shopify Plus plan.

Access required

Requires access to the Advanced DOM Events in web pixel app extensions scope. To request access, please use the form in the Partner Dashboard. This scope is only available for apps that have a heatmap and/or session recordings. The Advanced DOM Events cannot be used on custom apps.

advanced_dom_available

The advanced_dom_available event is published when the DOM has been loaded and is available for interaction.

advanced_dom_changed

The advanced_dom_changed event is published when the DOM has been changed in any way, such as an element being added, removed, or modified.

advanced_dom_clicked

The advanced_dom_clicked event is published when a customer clicks on a page element.

advanced_dom_clipboard

The advanced_dom_clipboard event is published when a customer has cut, copied or pasted text to or from the clipboard.

advanced_dom_form_submitted

The advanced_dom_form_submitted event is published when a form on a page is submitted.

advanced_dom_input_blurred

The advanced_dom_input_blurred event is published when an input on a page loses focus.

advanced_dom_input_changed

The advanced_dom_input_changed event is published when an input value changes.

advanced_dom_input_focused

The advanced_dom_input_focused event is published when an input on a page gains focus.

advanced_dom_mouse_moved

The advanced_dom_mouse_moved event is published when a customer moves their cursor over the page.

advanced_dom_scrolled

The advanced_dom_scrolled event is published when a customer scrolls on a page or in a scrollable element.

advanced_dom_selection_changed

The advanced_dom_selection_changed event is published when a customer uses text selection on a page.

advanced_dom_window_resized

The advanced_dom_window_resized event is published when a customer resizes their browser window.