Downloading Report Analytics data using API

Updated On 03 Mar 2021
1 Minute To Read

Print
Share
Dark
Light
PDF

Article Summary

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.

The integration key value is your User API token. To get your API token, see Generating the API token

integration_key_csv_report_api
3. Click the + icon on the top-right.
click_plus_icon_modheader
4. Select Request Header.
req_header
5. Enter the next header x-whatfix-user and its value. The value is your Whatfix email address.
whatix_user_header_value

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

Navigate 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
Now, 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

To get your Account ID, contact support@whatfix.com

final_url_explain
9. Copy and paste the final URL in a new tab and click Enter.
10. The CSV file is downloaded.
csv_Report_download_api

Was this article helpful?

What's Next

Pop-up Analytics