AhaSend · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for AhaSend API v2 Statistics API

4 actions 4 updates phrasing extends openapi/ahasend-statistics-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for AhaSend's API. It is a proposal applied on top of the contract, not a document AhaSend publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/v2/accounts/{account_id}/statistics/transactional/deliverability'].get

$.paths['/v2/accounts/{account_id}/statistics/transactional/bounce'].get

$.paths['/v2/accounts/{account_id}/statistics/transactional/delivery-time'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for AhaSend API v2 Statistics API
  version: 1.0.0
extends: openapi/ahasend-statistics-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: 3
- target: $.paths['/v2/accounts/{account_id}/statistics/transactional/deliverability'].get
  update:
    x-apievangelist-phrasing:
      intent: Report delivery outcomes by status
      effect: read
      questions:
      - How many of my transactional emails were delivered versus deferred or failed?
      - Can I see my deliverability broken down by day?
      instructions:
      - text: Show deliverability stats by status for account {account_id} from {from_time} to {to_time}.
        slots:
          account_id: path.account_id
          from_time: query.from_time
          to_time: query.to_time
      - text: Report delivery status counts for sender domain {sender_domain} grouped by {group_by} on account {account_id}.
        slots:
          sender_domain: query.sender_domain
          group_by: query.group_by
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/accounts/{account_id}/statistics/transactional/bounce'].get
  update:
    x-apievangelist-phrasing:
      intent: Report bounces by classification
      effect: read
      questions:
      - Why are my emails bouncing — what bounce classifications show up most?
      - Can I break down bounce counts for mail sent to one recipient domain?
      instructions:
      - text: Show bounce statistics by classification for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Break down bounces to recipient domains {recipient_domains} on account {account_id} since {from_time}.
        slots:
          recipient_domains: query.recipient_domains
          account_id: path.account_id
          from_time: query.from_time
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/accounts/{account_id}/statistics/transactional/delivery-time'].get
  update:
    x-apievangelist-phrasing:
      intent: Report how long delivery takes per domain
      effect: read
      questions:
      - How long does it take my emails to reach each recipient domain?
      - Which mailbox providers are slowest to accept my transactional mail?
      instructions:
      - text: Show delivery time statistics by recipient domain for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Report delivery latency for messages tagged {tags} on account {account_id}, grouped by {group_by}.
        slots:
          tags: query.tags
          account_id: path.account_id
          group_by: query.group_by
      method: generated
      generated: '2026-09-26'