Thanks to visit codestin.com
Credit goes to help.mouseflow.com

Skip to main content

Getting Started with REST API

Updated over 2 months ago

💡This feature is available on Premium & Enterprise plans.

Mouseflow is built with an API-first approach. Everything you can do in the Mouseflow web app is also available through our REST API, making it easy to access, analyze, and integrate your data programmatically.

The API uses JSON for both input and output, giving you a flexible way to work with your Mouseflow data.


What You Can Do with the REST API

With the Mouseflow API, you can:

  • Extract data – export recordings, pageviews, heatmaps, funnels, forms, and feedback responses.

  • Integrate with your tools – pull Mouseflow data into BI platforms, CRMs, or internal dashboards.

  • Build custom solutions – create widgets, apps, or workflows that rely on user behavior insights.

For Service Providers

If you manage Mouseflow for multiple clients, the API helps you:

  • Give clients access to their own website data only, without exposing other accounts.

  • Embed Mouseflow insights directly into your platform, product, or mobile app.


Authentication and Tokens

To use the API, you’ll need an API token:

  1. Log in to your Mouseflow account.

  2. Click on your name (top-right corner) → API.

  3. Copy your API token.

  4. You’ll include this token when authenticating requests.


Documentation

Full API reference and code examples are available here: Mouseflow REST API Documentation

JavaScript API Documentation – for customizing the tracking snippet and pushing custom data.

📝Data returned by the API can vary depending on your account region due to privacy regulations.

For any questions regarding this guide, please reach out to our Support Team: [email protected]

Did this answer your question?