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

Iterable Events API

Track custom events, retrieve event data for users, and manage event metadata used for segmentation and campaign triggering.

Iterable Events API is one of 23 APIs that Iterable publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 3 paths, and defines 3 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.

3 operations 3 paths 3 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.iterable.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Iterable Events 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 — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Events 3

Track custom events, retrieve event data for users, and manage event metadata used for segmentation and campaign triggering.

POST
/events/track
Track a custom event
trackEvent body → 200400401
POST
/events/trackBulk
Track multiple events in bulk
trackBulkEvents body → 200400401
GET
/events/{email}
Get events for a user by email
getEventsByEmail 2 params → 200401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are TrackEventRequest (7 properties), Event (5 properties), IterableResponse (3 properties). Each schema is shown below with its type and property counts.

IterableResponse
object
Standard Iterable API response indicating success or failure
3 properties
TrackEventRequest
object
Request body for tracking a custom event
7 properties 2 required
Event
object
An event tracked for a user
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

iterable-events-api-openapi.yml Raw ↑

Other APIs Iterable publishes across the network.

Iterable Export API
Iterable Web SDK
Iterable iOS SDK
Iterable Android SDK
Iterable React Native SDK
Iterable Campaigns API
Iterable Catalogs API
Iterable Channels API
Iterable Commerce API
Iterable Email API
Iterable ExperimentMetrics API
Iterable Experiments API