Iterable REST API — Experiments

naftiko: 1.0.0-alpha2
info:
  label: Iterable REST API — Experiments
  description: 'Iterable REST API — Experiments. 1 operations. Lead operation: Get experiment metrics. Self-contained Naftiko
    capability covering one Iterable business surface.'
  tags:
  - Iterable
  - Experiments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ITERABLE_API_KEY: ITERABLE_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-experiments
    baseUri: https://api.iterable.com/api
    description: Iterable REST API — Experiments business capability. Self-contained, no shared references.
    resources:
    - name: experiments-metrics
      path: /experiments/metrics
      operations:
      - name: getexperimentmetrics
        method: GET
        description: Get experiment metrics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: experimentId
          in: query
          type: array
          description: One or more experiment IDs
        - name: campaignId
          in: query
          type: array
          description: One or more campaign IDs
    authentication:
      type: apikey
      key: Api-Key
      value: '{{env.ITERABLE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: rest-experiments-rest
    port: 8080
    description: REST adapter for Iterable REST API — Experiments. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/experiments/metrics
      name: experiments-metrics
      description: REST surface for experiments-metrics.
      operations:
      - method: GET
        name: getexperimentmetrics
        description: Get experiment metrics
        call: rest-experiments.getexperimentmetrics
        with:
          experimentId: rest.experimentId
          campaignId: rest.campaignId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-experiments-mcp
    port: 9090
    transport: http
    description: MCP adapter for Iterable REST API — Experiments. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: get-experiment-metrics
      description: Get experiment metrics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-experiments.getexperimentmetrics
      with:
        experimentId: tools.experimentId
        campaignId: tools.campaignId
      outputParameters:
      - type: object
        mapping: $.