Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.integrate.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Use the Mouseflow source component to read website analytics, session recordings, funnels, forms, and feedback from your Mouseflow account into your Integrate.io ETL pipeline.

​
Connection

Select an existing Mouseflow connection or create a new one. A Mouseflow connection requires:
  • Email. The email address tied to your Mouseflow account.
  • API Key. The API key generated in your Mouseflow account settings.
  • Website ID (optional). A default website to query when a source component does not specify its own.
The Website ID field on the connection is optional. Leave it blank when a single set of API credentials needs to read from multiple Mouseflow websites. Set the website per source component instead. The field stays visible only on legacy connections that already have a value saved.

​
Source Properties

The source component is configured in Step 02 of the component editor.

​
Website

The Website picker selects which Mouseflow website the source reads from. The picker loads the list of websites available to the connection’s API credentials.
  • The Website picker is shown when the connection has no default Website ID set. In that case, every source component must pick its own website.
  • When the connection has a default Website ID, the picker is hidden and the connection-level value is used automatically. To read from a different website, create a separate connection without a default Website ID.
The websites object does not require a website selection; it lists every website your credentials can access. The recordings, funnels, forms, and feedback objects require a website. The pipeline fails to start if no website is set on either the source or the connection.
Click the Refresh button next to the dropdowns to reload the lists of available websites and objects.

​
Source Table (Object)

Select the Mouseflow object to read data from:
ObjectDescriptionWebsite required
websitesAll websites available to the connection’s API credentials. Useful for discovering the Website IDs to use elsewhere.No
recordingsSession recordings captured for the selected website, including visitor metadata, duration, and page counts.Yes
funnelsConversion funnels configured for the selected website, including step definitions and conversion stats.Yes
formsForm analytics for the selected website, including drop-off and completion data per field.Yes
feedbackFeedback campaign responses collected from visitors on the selected website.Yes

​
Load Type

Select how records are loaded on each pipeline run:
  • Full Load. Fetches all records for the selected object on every run.
  • Incremental Load. Fetches only records created or updated after a reference date. Use this for scheduled pipelines to avoid re-processing historical data.

​
Incremental Load Settings

When Incremental Load is selected, the following options appear: Sync date field. The date field used to filter records (for example, created_at or updated_at). Load records. The filter condition:
  • newer than: Fetch records after the reference date.
  • older than: Fetch records before the reference date.
Reference date. Choose the source of the date value:
  • Fixed Date. Pick a specific calendar date.
  • Variable. Use a system or custom variable. The recommended value for scheduled pipelines is $package_last_successful_job_submission_timestamp, which advances the start date after each successful run.

​
Schema

After configuring the source properties, the Schema section (Step 03) displays the available fields with their detected data types. Use the field selector to choose which columns to include in your pipeline. You can rename fields with aliases and change data types as needed. The schema for recordings, funnels, forms, and feedback depends on the website you select, because field availability is scoped to each website’s configuration.

​
API: List Websites for a Connection

The component editor’s Website picker calls a metadata endpoint that lists every Mouseflow website reachable through a stored connection. Build custom tooling against the same endpoint: 
GET /:account_id/api/connections/metadata/mouseflow/:connection_id/websites
The response contains the websites returned by the Mouseflow API for the credentials saved on the connection.
Last modified on May 12, 2026