Mouseflow is designed with an API-first approach, ensuring that all data and actions available through the web user interface are also accessible via our REST-based API. This API uses JSON for both input and output, providing a robust and flexible way to interact with your Mouseflow data.
Capabilities of the API:
Mouseflow API enables you to:
Extract Data: Retrieve session replay data, page analysis data, and statistics directly from your Mouseflow account.
Integration: Seamlessly incorporate Mouseflow data into your existing products, improving your services with detailed user interaction insights.
Custom Solutions: Create widgets/apps that use information from your Mouseflow account.
For Service Providers
If you offer Mouseflow services to your clients as part of your service portfolio, the API is an invaluable tool. It allows your clients to access specific Mouseflow data without exposing access to other websites or sensitive account information. You can even integrate Mouseflow data into your existing software or mobile apps 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.
API Documentation
You can view the complete API documentation as well as examples (in various programming languages) in our API documentation.
Important: To use the API you’ll need an API token that can be found under the API page on your Mouseflow account (click your email in the upper right to see the menu). Click the API menu to get the token and read more.
Additional Resources
For those interested in integrating with the Mouseflow tracking snippet directly, please refer to our integration documentation. This resource provides detailed instructions on how to customize and deploy the tracking snippet within your projects.
📝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: support@mouseflow.com