Holistics API

Holistics API#

We allow you to programmatically work with Holistics API. For example:

  • You can programmatically retrieve CSV, XLSX and JSON data from any Holistics report.
  • You can use our API to trigger execution of an email schedule, transform or data import.
  • etc...

This is useful especially if you need to pass live data to your other applications. For example, you may want to feed a live CSV endpoint of your user segmentation list into your email marketing application so that you can always get fresh data upon retrieving them.

Allow user API access#

First of all, you need to grant User permission to access API in User Management. Edit the User and tick on the checkbox Allow API access

API Key#

To retrieve the data without the need to manually log in, you can generate a unique API key from each user's account.

Please visit your user settings and generate a user token.

New API Key

Then you can set the API key in request header and call our API. An example is our report data export API link.

API Request Authorization#

When calling our API endpoints, we will authorize with your API key. Please set the custom X-Holistics-Key header to your API key.


curl -X POST \
-H "Accept:application/json" \
-H "Content-Type:application/json" \
-H "X-Holistics-Key:api_key" \