Mouseflow Destination

Mouseflow is a session replay and heatmap tool that shows how visitors click, move, scroll, browse, and pay attention on websites. It helps clients simplify their analytics to make decisions that matter. The analytics.js Mouseflow Destination is open-source. You can browse the code on GitHub.

This document was last updated on April 28, 2018. If you notice any gaps, outdated information or simply want to leave some feedback to help us improve our documentation, please let us know!

Getting Started

The first step is to make sure Mouseflow supports the source type and connection mode you’ve chosen to implement. You can learn more about what dictates the connection modes we support here.

WebMobileServer
📱 Device-based
☁️ Cloud-based
  1. From your Segment UI’s Destinations page click on “Add Destination”.
  2. Search for “Mouseflowl” within the Destinations Catalog and confirm the Source you’d like to connect to.
  3. Drop in your Site ID within the Segment Settings UI. You can find this in your Mouseflow UI.
  4. In about 5-10 minutes the CDN will be updated and Mouseflow snippet will be initialized onto your page.

Page

If you haven’t had a chance to review our spec, please take a look to understand what the Page method does. An example call would look like:

analytics.page()

An initial page call is required for data to be sent to Mouseflow via Analytics.js and sends a page view. This is included by default in your Segment snippet.

Identify

If you haven’t had a chance to review our spec, please take a look to understand what the Identify method does. An example call would look like:

analytics.identify('user1234', {
  email: 'petergibbon@email.com',
  firstname: 'Peter',
  lastname: 'Gibbon'
})

When you call Identify, the traits you set will be sent as custom variables to Mouseflow.


If you have any questions, or see anywhere we can improve our documentation, please let us know!