# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Sendgrid Stats API
  version: 1.0.0
extends: openapi/sendgrid-stats-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 15
- target: $.paths['/v3/marketing/stats/automations'].get
  update:
    x-apievangelist-phrasing:
      intent: Get stats for all Automations
      effect: read
      questions:
      - How are my marketing Automations performing overall?
      - Can I pull stats for just a handful of Automations by their IDs?
      instructions:
      - text: Show stats for all my Automations.
      - text: Get Automation stats for IDs {automation_ids}.
        slots:
          automation_ids: query.automation_ids
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/stats/automations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get stats for one Automation
      effect: read
      questions:
      - Can I break down a single Automation's stats by step over a date range?
      - What were the daily results for one Automation last month?
      instructions:
      - text: Get stats for Automation {id}.
        slots:
          id: path.id
      - text: Show Automation {id} stats from {start_date} to {end_date} grouped {aggregated_by}.
        slots:
          id: path.id
          start_date: query.start_date
          end_date: query.end_date
          aggregated_by: query.aggregated_by
      - text: Break down Automation {id} by step for steps {step_ids}.
        slots:
          id: path.id
          step_ids: query.step_ids
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/stats/automations/{id}/links'].get
  update:
    x-apievangelist-phrasing:
      intent: Get link clicks for an Automation
      effect: read
      questions:
      - Which links in my Automation emails get the most clicks?
      - Can I see click counts per URL for a specific Automation step?
      instructions:
      - text: Show link click stats for Automation {id}.
        slots:
          id: path.id
      - text: List clicks per URL in Automation {id} for steps {step_ids}.
        slots:
          id: path.id
          step_ids: query.step_ids
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/stats/automations/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export Automation stats as CSV
      effect: read
      questions:
      - Can I download my Automation stats as a CSV file?
      - Is there a way to export stats for several Automations at once in spreadsheet form?
      instructions:
      - text: Export Automation stats as CSV for IDs {ids}.
        slots:
          ids: query.ids
      - text: Download a CSV of Automation stats for {ids} in timezone {timezone}.
        slots:
          ids: query.ids
          timezone: query.timezone
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/stats/singlesends'].get
  update:
    x-apievangelist-phrasing:
      intent: Get stats for all Single Sends
      effect: read
      questions:
      - How did all my Single Send campaigns perform?
      - Can I compare stats across a chosen set of Single Sends?
      instructions:
      - text: Show stats for all my Single Sends.
      - text: Get Single Send stats for IDs {singlesend_ids}.
        slots:
          singlesend_ids: query.singlesend_ids
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/stats/singlesends/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get stats for one Single Send
      effect: read
      questions:
      - What were the opens and clicks for one particular Single Send?
      - Can I see an A/B tested Single Send's results broken out by variation?
      instructions:
      - text: Get stats for Single Send {id}.
        slots:
          id: path.id
      - text: Show Single Send {id} stats from {start_date} to {end_date} by {aggregated_by}.
        slots:
          id: path.id
          start_date: query.start_date
          end_date: query.end_date
          aggregated_by: query.aggregated_by
      - text: Break down Single Send {id} results grouped by {group_by}.
        slots:
          id: path.id
          group_by: query.group_by
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/stats/singlesends/{id}/links'].get
  update:
    x-apievangelist-phrasing:
      intent: Get link clicks for a Single Send
      effect: read
      questions:
      - Which URLs in a Single Send got clicked, and how often?
      - Can I see link clicks for just one A/B variation of a Single Send?
      instructions:
      - text: Show link click stats for Single Send {id}.
        slots:
          id: path.id
      - text: List link clicks in Single Send {id} for A/B variation {ab_variation_id}.
        slots:
          id: path.id
          ab_variation_id: query.ab_variation_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/stats/singlesends/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export Single Send stats as CSV
      effect: read
      questions:
      - Can I export my Single Send results to a CSV for a report?
      - What's the way to download stats for several Single Sends as one spreadsheet?
      instructions:
      - text: Export Single Send stats as CSV for IDs {ids}.
        slots:
          ids: query.ids
      - text: Download a CSV of Single Send stats for {ids} in timezone {timezone}.
        slots:
          ids: query.ids
          timezone: query.timezone
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/browsers/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get email stats by browser
      effect: read
      questions:
      - Which web browsers are my recipients using to open and click my emails?
      - Can I see click stats for Chrome versus Firefox recipients this week?
      instructions:
      - text: Show email stats by browser since {start_date}.
        slots:
          start_date: query.start_date
      - text: Get browser stats for {browsers} from {start_date} to {end_date}.
        slots:
          browsers: query.browsers
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/clients/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get email stats across all client types
      effect: read
      questions:
      - Are my recipients reading email mostly on phones, tablets, webmail or desktop?
      - What does the split of opens across every email client type look like?
      instructions:
      - text: Show email stats across all client types since {start_date}.
        slots:
          start_date: query.start_date
      - text: Get client type stats from {start_date} to {end_date} grouped by {aggregated_by}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
          aggregated_by: query.aggregated_by
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/clients/{client_type}/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get email stats for one client type
      effect: read
      questions:
      - How many opens came from just phone clients over the past few days?
      - Can I narrow client stats to only webmail readers?
      instructions:
      - text: Show email stats for {client_type} clients since {start_date}.
        slots:
          client_type: path.client_type
          start_date: query.start_date
      - text: Get {client_type} opens from {start_date} to {end_date}.
        slots:
          client_type: path.client_type
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/devices/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get email stats by device type
      effect: read
      questions:
      - What kinds of devices are my recipients opening emails on?
      - Can I get device type stats grouped by week?
      instructions:
      - text: Show email stats by device type since {start_date}.
        slots:
          start_date: query.start_date
      - text: Get device stats from {start_date} to {end_date} aggregated by {aggregated_by}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
          aggregated_by: query.aggregated_by
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/geo/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get email stats by country and region
      effect: read
      questions:
      - Where in the world are my email opens and clicks coming from?
      - Can I see engagement for recipients in just one country?
      instructions:
      - text: Show email stats by country and state since {start_date}.
        slots:
          start_date: query.start_date
      - text: Get geographic email stats for {country} from {start_date} to {end_date}.
        slots:
          country: query.country
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/mailbox_providers/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get email stats by mailbox provider
      effect: read
      questions:
      - How does my delivery and engagement differ between recipient mailbox providers?
      - Can I filter stats to specific inbox providers my recipients use?
      instructions:
      - text: Show email stats by mailbox provider since {start_date}.
        slots:
          start_date: query.start_date
      - text: Get stats for mailbox providers {mailbox_providers} from {start_date} to {end_date}.
        slots:
          mailbox_providers: query.mailbox_providers
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get global email statistics
      effect: read
      questions:
      - What are my overall delivered, open and bounce numbers for a date range?
      - Can I see my account-wide email stats rolled up by month?
      instructions:
      - text: Show my global email stats since {start_date}.
        slots:
          start_date: query.start_date
      - text: Get global email stats from {start_date} to {end_date} aggregated by {aggregated_by}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
          aggregated_by: query.aggregated_by
      method: generated
      generated: '2026-09-24'