Top
Downloading Report Analytics data using API
  • 01 Sep 2022
  • 1 Minute To Read
  • Dark
    Light
  • PDF

Downloading Report Analytics data using API

  • Dark
    Light
  • PDF

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.

Use the following steps to download the data using API,

  1. Install the extension - ModHeader from the Chrome Store.
    download_modheader

  2. Open the extension and enter the header x-whatfix-integration-key and its value.
    integration_key_csv_report_api

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

  1. On the top right, click the + icon.
    click_plus_icon_modheader

  2. Select Request header
    req_header

  3. 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.
  1. Navigate to the Whatfix Reports API page and select the report you want to download.

  2. Click the GET button on the top right and copy the URL: 
    https://whatfix.com/api/v1/{accountId}/reports/summary/mostPopularFlows
    copy_reports_api_url

  3. 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
      final_url_explain

To get your Account ID, contact [email protected]whatfix.com.

  1. Copy and paste the final URL in a new tab and click Enter.
Note

The CSV file is downloaded.
csv_Report_download_api


Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.