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, let us know!

Getting Started

Before you start, make sure Mouseflow supports the source type and connection mode you’ve chosen to implement. You can learn more about connection modes here.

1. From the Segment web app, click Catalog.
2. Search for “Mouseflow” in the Catalog, select it, and choose which of your sources to connect the destination to.
3. In the destination settings, enter your Site ID within the Segment Settings UI. You can find this in your Mouseflow UI.

Your changes appear in the Segment CDN in about 45 minutes, and then Analytics.js starts asynchronously loading the Mouseflow snippet on your page and sending data.

Page

If you’re not familiar with the Segment Specs, 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 using Analytics.js and sends a page view. This is included by default in your Segment snippet.

Identify

If you’re not familiar with the Segment Specs, 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.

Settings

Segment lets you change these destination settings from the Segment app without having to touch any code.

Mouseflow HTML Delay

HTML Delay

Site ID

Your Mouseflow site ID.