# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Iterable Export API
  version: 1.0.0
extends: openapi/iterable-export-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/api/export/data.csv'].get
  update:
    x-apievangelist-phrasing:
      intent: Export analytics data as CSV
      effect: read
      questions:
      - Can I download email sends or opens as a CSV for a date range?
      - Which delimiter options exist for the CSV export?
      instructions:
      - text: Export {dataTypeName} data as CSV for range {range}.
        slots:
          dataTypeName: query.dataTypeName
          range: query.range
      - text: Download {dataTypeName} CSV from {startDateTime} to {endDateTime} for campaign {campaignId}.
        slots:
          dataTypeName: query.dataTypeName
          startDateTime: query.startDateTime
          endDateTime: query.endDateTime
          campaignId: query.campaignId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/export/data.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Export analytics data as JSON lines
      effect: read
      questions:
      - Can I export analytics data as JSON, one record per line?
      - What's required for the date range when exporting data to JSON?
      instructions:
      - text: Export {dataTypeName} data as JSON for range {range}.
        slots:
          dataTypeName: query.dataTypeName
          range: query.range
      - text: Export {dataTypeName} JSON with only fields {onlyFields}.
        slots:
          dataTypeName: query.dataTypeName
          onlyFields: query.onlyFields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/export/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent export jobs
      effect: read
      questions:
      - Which export jobs have I run recently in this project?
      - Can I filter export jobs to just the ones still running?
      instructions:
      - text: List my recent export jobs.
      - text: Show export jobs in state {jobState}.
        slots:
          jobState: query.jobState
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/export/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a background data export
      effect: write
      questions:
      - How do I kick off a large export that runs in the background?
      - Which output formats can a background export job produce?
      instructions:
      - text: Start a {outputFormat} export of {dataTypeName}.
        slots:
          outputFormat: requestBody.outputFormat
          dataTypeName: requestBody.dataTypeName
      - text: Start a background export of {dataTypeName} as {outputFormat} from {startDateTime} to {endDateTime}.
        slots:
          dataTypeName: requestBody.dataTypeName
          outputFormat: requestBody.outputFormat
          startDateTime: requestBody.startDateTime
          endDateTime: requestBody.endDateTime
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/export/userEvents'].get
  update:
    x-apievangelist-phrasing:
      intent: Export all events for one user
      effect: read
      questions:
      - Can I export every event for a single user, including custom events?
      - What format does a single user's event export come in?
      instructions:
      - text: Export all events for {email}.
        slots:
          email: query.email
      - text: Export events for user {userId} including custom events {includeCustomEvents}.
        slots:
          userId: query.userId
          includeCustomEvents: query.includeCustomEvents
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/export/{jobId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel an export job
      effect: destructive
      questions:
      - Can I stop a queued or running export job?
      - What's the rate limit on cancelling exports?
      instructions:
      - text: Cancel export job {jobId}.
        slots:
          jobId: path.jobId
      - text: Stop the running export {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/export/{jobId}/files'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an export job's status and files
      effect: read
      questions:
      - How do I check whether my export job is done and get its files?
      - Can I page through export files after a given file name?
      instructions:
      - text: Get the status and files for export job {jobId}.
        slots:
          jobId: path.jobId
      - text: List files for export {jobId} after {startAfter}.
        slots:
          jobId: path.jobId
          startAfter: query.startAfter
      method: generated
      generated: '2026-10-01'