API Evangelist conversational phrasing for Paubox Marketing Analytics API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Paubox Marketing Analytics API
  version: 1.0.0
extends: openapi/paubox-analytics-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['/analytics/campaign_mailing_send_totals'].get
  update:
    x-apievangelist-phrasing:
      intent: Get send totals for marketing campaigns
      effect: read
      questions:
      - What are the overall delivery and engagement totals across the campaigns I've sent?
      - Can I get the stats totals for just one campaign send instead of all of them?
      - How did my Paubox Marketing campaigns perform in aggregate?
      instructions:
      - text: Show me the aggregate stats for every campaign I've sent.
      - text: Total up the results for campaign send {campaign_mailing_send_id}.
        slots:
          campaign_mailing_send_id: query.campaign_mailing_send_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/campaign_mailing_sends_table'].get
  update:
    x-apievangelist-phrasing:
      intent: List sent campaigns as an analytics table
      effect: read
      questions:
      - Where can I see a row-by-row table of every campaign I've sent?
      - Can I search the sent-campaigns table by a field and value pair?
      - Is it possible to sort my sent campaign table by something other than creation date?
      instructions:
      - text: Pull the sent campaigns table sorted by {order_by}.
        slots:
          order_by: query.order_by
      - text: Search the sent campaigns table for {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/tracking_links_by_unique_link'].get
  update:
    x-apievangelist-phrasing:
      intent: Get link interaction stats grouped by unique link
      effect: read
      questions:
      - Which links in a campaign got clicked, grouped per unique link?
      - How many interactions did each distinct link in my sent campaign receive?
      instructions:
      - text: Break down the link interactions for campaign send {campaign_mailing_send_id} by unique link.
        slots:
          campaign_mailing_send_id: query.campaign_mailing_send_id
      - text: Show unique-link click analytics for send {campaign_mailing_send_id}, ordered {order}.
        slots:
          campaign_mailing_send_id: query.campaign_mailing_send_id
          order: query.order
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/subscribers_by_tracking_link'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscribers who interacted with a tracking link
      effect: read
      questions:
      - Who exactly clicked a particular link in my campaign email?
      - Can I see the list of subscribers tied to one tracking link in a campaign send?
      instructions:
      - text: List the subscribers who clicked link {html_id} in campaign send {campaign_mailing_send_id}.
        slots:
          html_id: query.html_id
          campaign_mailing_send_id: query.campaign_mailing_send_id
      - text: Find which contacts engaged with tracking link {html_id} from send {campaign_mailing_send_id}.
        slots:
          html_id: query.html_id
          campaign_mailing_send_id: query.campaign_mailing_send_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/campaign_mailing_deliveries_table'].get
  update:
    x-apievangelist-phrasing:
      intent: List per-recipient deliveries for a campaign
      effect: read
      questions:
      - How do I see the individual deliveries that went out for a campaign?
      - Can I look up deliveries by the marketing email itself rather than by a specific send?
      instructions:
      - text: Show the deliveries table for campaign send {campaign_mailing_send_id}.
        slots:
          campaign_mailing_send_id: query.campaign_mailing_send_id
      - text: List every delivery made for marketing email {campaign_mailing_id}.
        slots:
          campaign_mailing_id: query.campaign_mailing_id
      method: generated
      generated: '2026-10-01'