Mouseflow Help & Support

API documentation


The Mouseflow API lets you extract recording data, page analysis data and statistics from your Mouseflow account. You can integrate Mouseflow data in your existing products, create services that analyze or monitor your recording data or create widgets/apps that use information from your Mouseflow account.

If you sell Mouseflow services to a client base as a part of your service toolbox, you can use the API to let your clients access Mouseflow data directly without giving access to other websites or your account information. You can even integrate the Mouseflow data in your existing software or mobile apps and thereby giving your clients a unique user experience.

The feature is enabled for Growth or larger subscriptions and can be found under the Account menu.

About the API

The Mouseflow API is REST-based. Our API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, and we support cross-origin resource sharing (CORS) to allow you to interact securely with our API from a client-side web application. JSON will be returned in most responses from the API, including errors.

Mouseflow was built API-first to make sure that any data and action available in the web UI is also available through the API.

You can view the full API documentation as well as examples (in various programming languages) in our API documentation.

Important: In order to use the API you’ll need an API token that can be found under the API page on The API token is in the API section in the bottom left corner of the screen. You also find the URL to the API in the same section.


Have more questions? Submit a request


Powered by Zendesk