Top
Download Report Analytics data using API
  • 27 Aug 2024
  • 1 Minute To Read
  • Dark
    Light
  • PDF

Download Report Analytics data using API

  • Dark
    Light
  • PDF

Article summary

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

your title goes here

Different browsers and extensions can be used to perform the following task. In this article, Google Chrome browser with ModHeader extension is used 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

your title goes here

The integration key value is your User API token. To get your API token, see Generate 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

    your title goes here
    • Ensure that the extension is not paused.
    • If you're using multiple profiles, then ensure that you're using the correct profile.
  4. Go to the Whatfix Reports API.

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

  6. 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
    your title goes here

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

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

    your title goes here

    The CSV file is downloaded.
    csv_Report_download_api


Was this article helpful?

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.