Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for impact.com Export API

5 actions 5 updates phrasing extends openapi/impact-export-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Impact's API. It is a proposal applied on top of the contract, not a document Impact publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/{tenant_alias}/export/history/list'].get
$.paths['/{tenant_alias}/export'].post
$.paths['/{tenant_alias}/export/{exportId}'].get
$.paths['/{tenant_alias}/export/{exportId}/download'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for impact.com Export API
  version: 1.0.0
extends: openapi/impact-export-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/{tenant_alias}/export/history/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List past exports
      effect: read
      questions:
      - Which exports have been run in my referral tenant recently?
      - Can I find an export's ID if I lost it?
      instructions:
      - text: List exports in tenant {tenant}, {limit} per page.
        slots:
          tenant: path.tenant_alias
          limit: query.limit
      - text: Show recent export history for tenant {tenant}.
        slots:
          tenant: path.tenant_alias
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{tenant_alias}/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an asynchronous data export
      effect: write
      questions:
      - How do I export my referral program data to a file?
      - What formats and export types can I request?
      instructions:
      - text: Create a {type} export in tenant {tenant} as {format}.
        slots:
          tenant: path.tenant_alias
          type: requestBody.type
          format: requestBody.format
      - text: Queue an export of type {type} named {name} in tenant {tenant}.
        slots:
          tenant: path.tenant_alias
          type: requestBody.type
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{tenant_alias}/export/{exportId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an export's status
      effect: read
      questions:
      - Is my export finished yet or still pending?
      - Can I poll one export to see when it completes?
      instructions:
      - text: Check the status of export {export} in tenant {tenant}.
        slots:
          tenant: path.tenant_alias
          export: path.exportId
      - text: Look up export {export} in tenant {tenant}.
        slots:
          tenant: path.tenant_alias
          export: path.exportId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{tenant_alias}/export/{exportId}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a completed export file
      effect: read
      questions:
      - Where do I get the file once an export has completed?
      - Does an export have to be COMPLETED before I can download it?
      instructions:
      - text: Download the file for export {export} in tenant {tenant}.
        slots:
          tenant: path.tenant_alias
          export: path.exportId
      - text: Save completed export {export} from tenant {tenant}.
        slots:
          tenant: path.tenant_alias
          export: path.exportId
      method: generated
      generated: '2026-09-26'