Agent-ready OpenAPI document · curated by JenticAnalyticsProduct Analyticsbasic18 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
List and inspect Mouseflow session recordings, manage tags and stars on individual recordings, and pull heatmap data for tracked websites.
Use for: I need to list all websites in my Mouseflow account, Get the most recent session recordings for a specific site, Tag a recording with a label so it shows up in the QA queue, Find recordings currently in progress for a website
Not supported: Does not handle event funnels, A/B testing, or feature flag evaluation - use for Mouseflow session recordings, tags, and heatmaps only.
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.
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.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fmouseflow.com%2Fmouseflow" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fmouseflow.com%2Fmouseflow" | sh
jentic register # connects your agent to your Jentic One instanceJentic 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
Inspect in-progress recordings via /websites/{website_id}/recordings/inprogress
Tag, star, share, or mark a recording as watched via the per-recording endpoints
Manage the set of available recording tags for a website
Retrieve heatmaps associated with a website
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
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
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
M
Mouseflow API
- Foundational (D-)41/100
93
Foundational Compliance63
Developer Experience & Jentic Compatibility50
AI-Readiness & Agent Experience94
Agent Usability10
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
93
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
98%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
75%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
50
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: C-Signals: 4
39%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
62%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
10
Security
Trust, risk posture, and security compliance.
Grade: FSignals: 1
10%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring Mouseflow by hand means building its basic-auth header from your API key, targeting the regional host, and threading the website id through every recordings and tags call. Through Jentic you install once, import the Mouseflow API from the API Directory, store the key once, and your agent calls it.
Permission scoping
Mouseflow puts the website id in the URL path (/websites/{website_id}/...), so a rule can pin your agent to one website: it can read that site's recordings and tags and nothing else. You choose the operations it may call, so writes like tagging or starring a recording are not included unless you add them.
Credential isolation
Your Mouseflow API key is stored once, encrypted, by your own Jentic One instance and used to build the Authorization header at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'list session recordings' or 'tag a Mouseflow recording', and Jentic returns the matching operation with its input schema, so the agent picks the right call without scanning the docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
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 with Jentic One, the self-hosted execution layer.
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.
Can I limit what my agent is allowed to do with the Mouseflow API?
Yes. Because you run Jentic One yourself, your own rules decide which Mouseflow operations and credentials the agent may use. Mouseflow puts the website id in the URL path, so a rule can pin the agent to a single website and let it read only that site's recordings, tags, and heatmaps. You also choose the operations it may call, so write actions like tagging or starring a recording stay off unless you add them.
GET STARTED