Iterable Export API

naftiko: 1.0.0-alpha2
info:
  label: Iterable Export API
  description: The Iterable Export API enables developers to extract data from Iterable projects for analytics, reporting,
    and data warehousing purposes. It provides export endpoints that allow retrieval of user data, event data, campaign metrics,
    and message engagement information in CSV and JSON formats. The export endpoints support filtering by date ranges and
    event types, making it possible to build custom reporting pipelines and synchronize Iterable data with external business
    intelligence tools.
  tags:
  - Iterable
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: iterable
    baseUri: https://api.iterable.com/api
    description: Iterable Export API HTTP API.
    authentication:
      type: apikey
      in: header
      name: Api-Key
      value: '{{ITERABLE_TOKEN}}'
    resources:
    - name: export-data-json
      path: /export/data.json
      operations:
      - name: exportdatajson
        method: GET
        description: Export data as JSON
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: export-data-csv
      path: /export/data.csv
      operations:
      - name: exportdatacsv
        method: GET
        description: Export data as CSV
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: export-userevents
      path: /export/userEvents
      operations:
      - name: exportuserevents
        method: GET
        description: Export events for a specific user
        inputParameters:
        - name: email
          in: query
          type: string
          required: true
          description: Email address of the user whose events to export
        - name: includeCustomEvents
          in: query
          type: boolean
          description: Whether to include custom events in the export
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: experiments-metrics
      path: /experiments/metrics
      operations:
      - name: exportexperimentmetrics
        method: GET
        description: Export experiment metrics as CSV
        inputParameters:
        - name: experimentId
          in: query
          type: array
          description: One or more experiment IDs to export metrics for
        - name: campaignId
          in: query
          type: array
          description: One or more campaign IDs to export metrics for
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    port: 8080
    namespace: iterable-rest
    description: REST adapter for Iterable Export API.
    resources:
    - path: /export/data.json
      name: exportdatajson
      operations:
      - method: GET
        name: exportdatajson
        description: Export data as JSON
        call: iterable.exportdatajson
        outputParameters:
        - type: object
          mapping: $.
    - path: /export/data.csv
      name: exportdatacsv
      operations:
      - method: GET
        name: exportdatacsv
        description: Export data as CSV
        call: iterable.exportdatacsv
        outputParameters:
        - type: object
          mapping: $.
    - path: /export/userEvents
      name: exportuserevents
      operations:
      - method: GET
        name: exportuserevents
        description: Export events for a specific user
        call: iterable.exportuserevents
        outputParameters:
        - type: object
          mapping: $.
    - path: /experiments/metrics
      name: exportexperimentmetrics
      operations:
      - method: GET
        name: exportexperimentmetrics
        description: Export experiment metrics as CSV
        call: iterable.exportexperimentmetrics
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    port: 9090
    namespace: iterable-mcp
    transport: http
    description: MCP adapter for Iterable Export API for AI agent use.
    tools:
    - name: exportdatajson
      description: Export data as JSON
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: iterable.exportdatajson
      outputParameters:
      - type: object
        mapping: $.
    - name: exportdatacsv
      description: Export data as CSV
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: iterable.exportdatacsv
      outputParameters:
      - type: object
        mapping: $.
    - name: exportuserevents
      description: Export events for a specific user
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: iterable.exportuserevents
      with:
        email: tools.email
        includeCustomEvents: tools.includeCustomEvents
      inputParameters:
      - name: email
        type: string
        description: Email address of the user whose events to export
        required: true
      - name: includeCustomEvents
        type: boolean
        description: Whether to include custom events in the export
      outputParameters:
      - type: object
        mapping: $.
    - name: exportexperimentmetrics
      description: Export experiment metrics as CSV
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: iterable.exportexperimentmetrics
      with:
        experimentId: tools.experimentId
        campaignId: tools.campaignId
      inputParameters:
      - name: experimentId
        type: array
        description: One or more experiment IDs to export metrics for
      - name: campaignId
        type: array
        description: One or more campaign IDs to export metrics for
      outputParameters:
      - type: object
        mapping: $.
binds:
- namespace: env
  keys:
    ITERABLE_TOKEN: ITERABLE_TOKEN