Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Holistics Export API

Asynchronous report data export jobs.

Holistics Export API is one of 5 APIs that Holistics publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Export. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 3 paths, and defines 2 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

Requests are made against 3 base URLs: https://secure.holistics.io/api/v2, https://us.holistics.io/api/v2, https://eu.holistics.io/api/v2.

3 operations 3 paths 2 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
https://secure.holistics.io/api/v2
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Holistics Export API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Holistics-Key (HolisticsKey). By default, every request must be authenticated.

  • HolisticsKey — Per-user API key generated from Holistics user settings.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Export 3

Asynchronous report data export jobs.

GET
/queries/{report_id}/submit_export.{format}
Submit a report export job
submitReportExport 2 params → 200
GET
/queries/get_export_results.json
Retrieve export job status
getExportResults 1 param → 200
GET
/exports/download
Download an export result file
downloadExport 1 param → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Job (6 properties), JobSubmitResponse (2 properties). Each schema is shown below with its type and property counts.

Job
object
6 properties
JobSubmitResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

holistics-export-api-openapi.yml Raw ↑

Other APIs Holistics publishes across the network.

Holistics Data Pipeline API
Holistics Datasets API
Holistics Jobs API
Holistics Reports API