Mouseflow API

Name: Mouseflow API
Brand: Mouseflow API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentAnalyticsProduct Analyticsbasic18 EndpointsREST

For Agents

List and inspect Mouseflow session recordings, manage tags and stars on individual recordings, and pull heatmap data for tracked websites.

Install Jentic One Beta

Connect the Mouseflow API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Mouseflow API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Mouseflow API.

List the websites in a Mouseflow account via GET /websites

Read details of a specific website via GET /websites/{website_id}

List session recordings for a website via GET /websites/{website_id}/recordings

GET STARTED

Start building with Mouseflow API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for Mouseflow API, keeping it validated and agent-ready. Mouseflow is a session replay and behavioural analytics platform that records visitor sessions, generates heatmaps, and exposes tagging and variable controls for segmentation. The 18-endpoint API covers website management, listing and inspecting recordings, in-progress recording status, recording tags, share and watched flags, and heatmap retrieval. Authentication uses HTTP basic auth, with US and EU regional base URLs available.

Use Cases

Patterns agents use Mouseflow API for, with concrete tasks.

★ QA Triage from Session Recordings

Product and QA teams pull recent recordings from Mouseflow, tag them by symptom, and route them to the right engineer. The /websites/{website_id}/recordings list provides the queue, /websites/{website_id}/recordings/{recording_id}/tag attaches a label, and the watched flag tracks who has reviewed each one. This collapses a manual triage workflow into a scriptable loop.

List recordings for a website created in the last 24 hours, filter to those tagged 'error', and mark each as watched once a teammate reviews it.

Heatmap Retrieval for Conversion Pages

Conversion teams retrieve heatmap data from Mouseflow to understand where visitors click and scroll on critical landing pages. The heatmap endpoint returns the data needed to render heatmaps in internal dashboards or to compare versions of a page in a CMS-driven A/B workflow.

Retrieve the heatmap for a high-traffic landing page and feed the data into an internal dashboard.

In-Progress Recording Monitoring

Operations and support teams watch in-progress recordings to spot live frustration before sessions end. The /websites/{website_id}/recordings/inprogress endpoint exposes that live queue so an internal tool can flag potentially escalating sessions and alert support staff.

Poll /websites/{website_id}/recordings/inprogress and alert the support team if any session has been active for more than 10 minutes.

Behavioural Analytics Agent via Jentic

An AI analytics agent that needs to surface noteworthy sessions searches Jentic for the recording listing operation, loads its schema, and executes. Jentic injects the basic auth credentials, so the agent never sees the raw API key. The same agent can star or tag recordings via Jentic to keep them in front of human reviewers.

Search Jentic for 'list Mouseflow session recordings', load /websites/{website_id}/recordings, and execute it with the target website ID.

Key Endpoints

18 endpoints — jentic publishes the only available openapi specification for mouseflow api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/websites

List tracked websites

GET

/websites/{website_id}

Read a single website

GET

/websites/{website_id}/recordings

List recordings for a website

GET

/websites/{website_id}/recordings/inprogress

List in-progress recordings

GET

/websites/{website_id}/recordings/{recording_id}

Read a specific recording

GET

/websites/{website_id}/recordings/tags

List the tag catalogue for a website

POST

/websites/{website_id}/recordings/{recording_id}/tag

Tag a recording

POST

/websites/{website_id}/recordings/{recording_id}/star

Star a recording

GET

/websites

List tracked websites

GET

/websites/{website_id}

Read a single website

GET

/websites/{website_id}/recordings

List recordings for a website

GET

/websites/{website_id}/recordings/inprogress

List in-progress recordings

GET

/websites/{website_id}/recordings/{recording_id}

Read a specific recording

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Mouseflow basic-auth API keys are stored encrypted in the Jentic vault (MAXsystem). Jentic constructs the Authorization header at call time so the raw key never enters the agent's prompt or logs.

Intent-based discovery

Agents search Jentic with intents like 'list session recordings' or 'tag a Mouseflow recording' and Jentic returns the matching endpoint with input schema, so the agent can pick the right call without scanning docs.

Time to first call

Direct Mouseflow integration: half a day to handle paging across recordings and the basic-auth header. Through Jentic: minutes — search, load, execute.

FAQs

Specific to using Mouseflow API through Jentic.

Why is there no official OpenAPI spec for Mouseflow API?

Mouseflow does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Mouseflow API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Mouseflow API use?

Mouseflow uses HTTP basic authentication with an API key. Use the api-us.mouseflow.com or api-eu.mouseflow.com base URL depending on your account region. Through Jentic, the credentials live in the encrypted vault and are attached as the Authorization header at call time.

Can I retrieve session recordings via the Mouseflow API?

Yes. List a website's recordings via GET /websites/{website_id}/recordings and read individual recordings by ID. The API also exposes in-progress recordings, tags, star, share, and watched flags so an internal tool can drive a full triage workflow.

What are the rate limits for the Mouseflow API?

Mouseflow does not publish hard rate limits in the spec. Treat listings as paginated reads and avoid polling individual recordings inside tight loops; back off on 429 responses if encountered.

How do I list session recordings through Jentic?

Run pip install jentic, search 'list Mouseflow session recordings', load /websites/{website_id}/recordings, and execute it with the target website ID. Jentic supplies the basic-auth credentials from your vault.

Is the Mouseflow API free?

API access is included with paid Mouseflow plans. The free trial does not include API access in all configurations; check current pricing at mouseflow.com.