# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Iterable Experiments API
  version: 1.0.0
extends: openapi/iterable-experiments-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: 5
- target: $.paths['/api/experiments/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get email experiment metrics by date range
      effect: read
      questions:
      - Can I export A/B test metrics for an experiment within a date range?
      - Does experiment metrics export support channels other than email?
      instructions:
      - text: Get metrics for experiment {experimentId} from {startDateTime} to {endDateTime}.
        slots:
          experimentId: query.experimentId
          startDateTime: query.startDateTime
          endDateTime: query.endDateTime
      - text: Show /api experiment metrics for campaign {campaignId}.
        slots:
          campaignId: query.campaignId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experiments'].get
  update:
    x-apievangelist-phrasing:
      intent: List experiments
      effect: read
      questions:
      - Which experiments are running for a given campaign?
      - Can I filter experiments by state and date and page through them?
      instructions:
      - text: List experiments for campaign {campaignId}.
        slots:
          campaignId: query.campaignId
      - text: List experiments in state {state}, {limit} at a time.
        slots:
          state: query.state
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experiments/{experimentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one experiment
      effect: read
      questions:
      - How do I look up a single A/B experiment by its ID?
      - What settings does an experiment record include?
      instructions:
      - text: Get experiment {experimentId}.
        slots:
          experimentId: path.experimentId
      - text: Show me the details of experiment {experimentId}.
        slots:
          experimentId: path.experimentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experiments/{experimentId}/variants'].get
  update:
    x-apievangelist-phrasing:
      intent: List an experiment's variants
      effect: read
      questions:
      - What variants are being tested in my experiment?
      - Can I see every variant of an A/B test?
      instructions:
      - text: List variants for experiment {experimentId}.
        slots:
          experimentId: path.experimentId
      - text: Show all test variants of experiment {experimentId}.
        slots:
          experimentId: path.experimentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/experiments/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get A/B test metrics for many experiments
      effect: read
      questions:
      - How many experiment and campaign IDs can I query for metrics at once?
      - Is there a simple /experiments/metrics endpoint for A/B results?
      instructions:
      - text: Get A/B metrics for experiments {experimentId} via /experiments/metrics.
        slots:
          experimentId: query.experimentId
      - text: Pull experiment results for campaigns {campaignId} from the simple metrics endpoint.
        slots:
          campaignId: query.campaignId
      method: generated
      generated: '2026-10-01'