Downloading Report Analytics data using API

Updated On 16 Nov 2023
1 Minute To Read

Print
Share
Dark

Light
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

Whatfix Report APIs can be used to download Reports analytics data in csv format.

You can use different browsers and extensions to perform the following task. We have used Google Chrome browser with ModHeader extension as an example.

To download the data using API,

Install the extension - ModHeader from the Chrome Store.
Open the extension and enter the header x-whatfix-integration-key and its value.

Info

The integration key value is your User API token.
Click the + icon on the top-right.
Select Request Header.
Enter the next header x-whatfix-user and its value. The value is your Whatfix email address.

Make sure the extension is not paused.
If you're using multiple profiles then make sure you're using the correct profile.

Go to the Whatfix Reports API page and select the report you want to download.
Click the GET button on the top right and copy the URL - https://whatfix.com/api/v1/{accountId}/reports/summary/mostPopularFlows
Construct the URL to get the report.
- Replace {accountId} with your Account ID value - https://whatfix.com/api/v1/XXXxXxXx-XXXx-XxXX-XXXX-XXXxxxXxxX/reports/summary/mostPopularFlows
- Add the format parameter at the end - https://whatfix.com/api/v1/XXXxXxXx-XXXx-XxXX-XXXX-XXXxxxXxxX/reports/summary/mostPopularFlows?format=csv