Holistics API

Introduction

At Holistics, we treat API interface as a first-class citizen. Our goal is to allow you to flexibly integrate Holistics with your workflow as much as possible.

We do this by trying to design an extensive, easy to use API coupled with readily available libraries.

OpenAPI Specification

Download the OpenAPI spec (YAML) to use with API clients, code generators, or AI agents.

caution

Holistics API version does not correlate with Holistics feature version. For example, Holistics API v2 can support operations on Holistics 2.0, 2.7 and 3.0.

The latest API version is API v2.

API v1 and below is considered legacy API. Legacy API is functional but is not in active development/ maintenance anymore.

Use Cases

While there are many possible ideas, these are some common use cases that you could use our API for:

• Get Report Data: Use API to programmatically retrieve CSV, Excel data from any Holistics dashboard/chart. Useful if you need to pass live data to your other applications.
• Trigger data schedule executions: Integrate with your own workflow, use our API or CLI to trigger data schedule jobs.
• Manage/CRUD of Dashboard Schedules: Set up email report delivery to your customers when a new customer onboards.
• User Management (upcoming): Automatic provision/deprovision of users via our API.

info

Our API is currently work-in-progress, so some of the use cases/features might not be available. If you have an API use case you want to support/prioritize, please reach out to our Support.

Data Center Regions

API data is limited to specific regions. You must use the correct subdomain for your data center region.

Region	API Base URL
Asia-Pacific (APAC)	https://secure.holistics.io/api/v2
Europe (EU)	https://eu.holistics.io/api/v2
United States (US)	https://us.holistics.io/api/v2

Finding your region

Check the URL when you log into Holistics:

• secure.holistics.io → APAC
• eu.holistics.io → EU
• us.holistics.io → US

See Data Centers for more details.

Authentication

All API requests require authentication using an API key passed in the X-Holistics-Key header.

curl -X GET \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Holistics-Key: YOUR_API_KEY" \
  https://secure.holistics.io/api/v2/users/me

For step-by-step instructions on enabling API access, generating your API key, and making your first call, see the Getting Started guide.