# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Postmark Server Stats API
  version: 1.0.0
extends: openapi/postmark-stats-api-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: 12
- target: $.paths['/stats/outbound'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an overview of outbound email stats
      effect: read
      questions:
      - How is my outbound email performing overall this month?
      - Can I get a single summary of sends, bounces, spam and opens for a tag?
      instructions:
      - text: Give me the outbound stats overview from {fromdate} to {todate}.
        slots:
          fromdate: query.fromdate
          todate: query.todate
      - text: Summarize all outbound performance for tag {tag}.
        slots:
          tag: query.tag
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stats/outbound/sends'].get
  update:
    x-apievangelist-phrasing:
      intent: Count emails sent per day
      effect: read
      questions:
      - How many emails did I send each day last week?
      - What's my daily send volume for a particular tag?
      instructions:
      - text: Show daily sent counts since {fromdate}.
        slots:
          fromdate: query.fromdate
      - text: Count the emails sent with tag {tag} up to {todate}.
        slots:
          tag: query.tag
          todate: query.todate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stats/outbound/bounces'].get
  update:
    x-apievangelist-phrasing:
      intent: Count bounces per day by type
      effect: read
      questions:
      - How many hard and soft bounces did I get each day?
      - Is my bounce volume trending up over a date range?
      instructions:
      - text: Show daily bounce counts from {fromdate} to {todate}.
        slots:
          fromdate: query.fromdate
          todate: query.todate
      - text: Chart bounce totals for messages tagged {tag}.
        slots:
          tag: query.tag
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stats/outbound/spam'].get
  update:
    x-apievangelist-phrasing:
      intent: Count spam complaints per day
      effect: read
      questions:
      - How many recipients marked my emails as spam?
      - Are spam complaints rising for one of my email campaigns?
      instructions:
      - text: Show spam complaint counts since {fromdate}.
        slots:
          fromdate: query.fromdate
      - text: Count spam complaints on email tagged {tag}.
        slots:
          tag: query.tag
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stats/outbound/tracked'].get
  update:
    x-apievangelist-phrasing:
      intent: Count emails sent with tracking enabled
      effect: read
      questions:
      - How many of my emails went out with open or link tracking turned on?
      - What share of a tag's messages were tracked?
      instructions:
      - text: Show the tracked email counts from {fromdate} to {todate}.
        slots:
          fromdate: query.fromdate
          todate: query.todate
      - text: Count tracked emails with tag {tag}.
        slots:
          tag: query.tag
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stats/outbound/opens'].get
  update:
    x-apievangelist-phrasing:
      intent: Count email opens per day
      effect: read
      questions:
      - How many opens and unique opens did my emails get each day?
      - What's the open trend for a specific tag over time?
      instructions:
      - text: Show daily open counts since {fromdate}.
        slots:
          fromdate: query.fromdate
      - text: Count total and unique opens for tag {tag} up to {todate}.
        slots:
          tag: query.tag
          todate: query.todate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stats/outbound/opens/platforms'].get
  update:
    x-apievangelist-phrasing:
      intent: Break down opens by device platform
      effect: read
      questions:
      - Are my emails opened more on mobile, desktop or webmail?
      - What platform split do opens show for one tag?
      instructions:
      - text: Break down email opens by mobile, desktop and webmail since {fromdate}.
        slots:
          fromdate: query.fromdate
      - text: Show the open platform mix for tag {tag}.
        slots:
          tag: query.tag
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stats/outbound/opens/emailclients'].get
  update:
    x-apievangelist-phrasing:
      intent: Break down opens by email client
      effect: read
      questions:
      - Which email clients do my recipients open messages in?
      - Should I test templates in a particular mail app, based on what my readers use?
      instructions:
      - text: Show which email clients opened messages between {fromdate} and {todate}.
        slots:
          fromdate: query.fromdate
          todate: query.todate
      - text: Rank email clients by opens for tag {tag}.
        slots:
          tag: query.tag
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stats/outbound/clicks'].get
  update:
    x-apievangelist-phrasing:
      intent: Count link clicks per day
      effect: read
      questions:
      - How many link clicks did my emails get each day?
      - What's the daily click volume on messages with one tag?
      instructions:
      - text: Show daily click counts since {fromdate}.
        slots:
          fromdate: query.fromdate
      - text: Count total and unique clicks for tag {tag} through {todate}.
        slots:
          tag: query.tag
          todate: query.todate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stats/outbound/clicks/browserfamilies'].get
  update:
    x-apievangelist-phrasing:
      intent: Break down link clicks by browser
      effect: read
      questions:
      - Which browsers do recipients use when they click my email links?
      - What browser family split do clicks show for a tag?
      instructions:
      - text: Break down email link clicks by browser family since {fromdate}.
        slots:
          fromdate: query.fromdate
      - text: Show the browser mix of clicks for tag {tag}.
        slots:
          tag: query.tag
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stats/outbound/clicks/platforms'].get
  update:
    x-apievangelist-phrasing:
      intent: Break down link clicks by device platform
      effect: read
      questions:
      - Do people click my email links more from phones or desktops?
      - What platform split do link clicks show over a date range?
      instructions:
      - text: Break down link clicks by mobile versus desktop from {fromdate} to {todate}.
        slots:
          fromdate: query.fromdate
          todate: query.todate
      - text: Show the click platform mix for tag {tag}.
        slots:
          tag: query.tag
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stats/outbound/clicks/location'].get
  update:
    x-apievangelist-phrasing:
      intent: Compare clicks in HTML versus text parts
      effect: read
      questions:
      - Are recipients clicking links in the HTML part or the plain text part of my emails?
      - Which body location gets more clicks for a given tag?
      instructions:
      - text: Show clicks by HTML versus text body location since {fromdate}.
        slots:
          fromdate: query.fromdate
      - text: Compare where in the email body links were clicked for tag {tag}.
        slots:
          tag: query.tag
      method: generated
      generated: '2026-10-01'