Iterable Export API
The Iterable Export API enables developers to extract data from Iterable projects for analytics, reporting, and data warehousing purposes. It provides asynchronous export endpoints that allow bulk retrieval of user data, event data, campaign metrics, and message engagement information. The export endpoints support filtering by date ranges and other criteria, making it possible to build custom reporting pipelines and synchronize Iterable data with external business intelligence tools.
Iterable Export API is one of 23 APIs that Iterable publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Analytics, Data Export, Marketing Data, and Reporting. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.
This API exposes 3 operations across 3 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api.iterable.com/api, https://api.eu.iterable.com/api.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Iterable Export API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Api-Key (apiKeyAuth).
By default, every request must be authenticated.
apiKeyAuth— Iterable API key passed in the Api-Key header. API keys can be created and managed in the Iterable project 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.
Endpoints for exporting data from Iterable projects in CSV and JSON formats. Supports exporting user events, message engagement data, and campaign metrics.
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are ExportedEvent (15 properties), ErrorResponse (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Iterable 12
Other APIs Iterable publishes across the network.