Understanding Mixpanel's Scroll Event Parameters
according to docs, "scroll When set, Mixpanel will collect page scrolls at specified scroll intervals. true" and what specific parameters they collect in scroll event?
according to docs, "scroll When set, Mixpanel will collect page scrolls at specified scroll intervals. true" and what specific parameters they collect in scroll event?
When Mixpanel's Autocapture is enabled and the scroll option is set to true, Mixpanel collects scroll events at specified scroll intervals. The specific parameters (event properties) collected in a scroll event include:
- $scroll_checkpoint: The percentage of the scrollbar that has been reached when crossing specific thresholds (e.g., 25%, 50%, 75%, 100%).
- $scroll_height: The height of the scrollable area of the page.
- $scroll_percentage: The percentage of the page that has been scrolled.
- $scroll_top: The number of pixels the page has been scrolled vertically.
Other general event properties that may be included (depending on the event and context) are:
- $event_type
- $host
- $pathname
- $elements
- $target
- $viewportHeight
- $viewportWidth
- $pageHeight
- $pageWidth
- $screenX
- $screenY
- $x
- $y
These properties help you understand how users interact with your page through scrolling, including how far they scroll and at what points key scroll events are triggered Docs: Javascript SDK Autocapture.
kapa.ai is still learning and improving, please let me know how I did by reacting below.
ℹ️ Tip: Mention @kapa.ai in the thread for follow-ups or DM the app for 1-to-1 help.
Let me check the knowledge base for you again. One moment! 📚
Yes, you can add a user_id and page name property to scroll events, but not directly through the default Autocapture configuration.
- user_id: Mixpanel automatically includes a $user_id property on events if you have identified the user using the identify method in your implementation. This means that if you call mixpanel.identify('USER_ID') before the event is captured, the $user_id will be included in all subsequent events, including scroll events Docs: Identify Users.
- page name: Autocapture does not add a custom page name property by default. However, you can register a super property (e.g., page_name) using mixpanel.register({ page_name: 'Your Page Name' }) before the scroll event occurs. Super properties are automatically included in all events, including those captured by Autocapture Docs: Setting Super Properties.
Example:
mixpanel.identify('USER_ID');
mixpanel.register({ page_name: 'Pricing' });
After running this code, both $user_id and page_name will be included in all subsequent events, including scroll events, as long as the user remains on the page and the properties are registered.
Note: You cannot directly modify the properties of an individual Autocapture event at the moment it is captured, but super properties and user identification are the recommended way to include additional context Docs: Events and Properties Best Practices.
kapa.ai is still learning and improving, please let me know how I did by reacting below.
ℹ️ Tip: Mention @kapa.ai in the thread for follow-ups or DM the app for 1-to-1 help.
Let me check the knowledge base for you again. One moment! 📚
You do not need to register a super property to identify the location of a scroll event. Mixpanel’s Autocapture automatically includes several properties that indicate where the scroll event occurred:
- $host: The hostname of the webpage where the event was triggered (e.g., example.com).
- $pathname: The path portion of the URL where the event occurred (e.g., /checkout).
- $current_url: The full URL of the page on which the event was tracked (for web events).
- $elements: A list of elements involved in the event, which can provide additional context.
These properties are automatically attached to scroll events and help you identify the exact page and location where the scroll occurred, without needing to manually add a page name property Docs: Javascript SDK Autocapture Default Properties Reference.
kapa.ai is still learning and improving, please let me know how I did by reacting below.
ℹ️ Tip: Mention @kapa.ai in the thread for follow-ups or DM the app for 1-to-1 help.