SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Subusers Subuser Statistics API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/v3/subusers/{subuser_name}/stats/monthly'].get
$.paths['/v3/subusers/stats'].get
$.paths['/v3/subusers/stats/monthly'].get
$.paths['/v3/subusers/stats/sums'].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 Twilio SendGrid Subusers Subuser Statistics API
  version: 1.0.0
extends: openapi/sendgrid-subuser-statistics-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: 4
- target: $.paths['/v3/subusers/{subuser_name}/stats/monthly'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one subuser's monthly email stats
      effect: read
      questions:
      - How did a single subuser's email perform in a given month?
      - Which metrics can't I sort a subuser's monthly stats by?
      instructions:
      - text: Show subuser {subuser_name}'s email stats for the month of {date}.
        slots:
          subuser_name: path.subuser_name
          date: query.date
      - text: Get {subuser_name}'s monthly stats for {date}, sorted by {sort_by_metric}.
        slots:
          subuser_name: path.subuser_name
          date: query.date
          sort_by_metric: query.sort_by_metric
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/subusers/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get email stats for chosen subusers
      effect: read
      questions:
      - Can I compare email statistics for several subusers over a date range?
      - How many subusers can I request stats for at once?
      instructions:
      - text: Get email stats for subusers {subusers} since {start_date}.
        slots:
          subusers: query.subusers
          start_date: query.start_date
      - text: Show stats for {subusers} from {start_date} to {end_date}, grouped by {aggregated_by}.
        slots:
          subusers: query.subusers
          start_date: query.start_date
          end_date: query.end_date
          aggregated_by: query.aggregated_by
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/subusers/stats/monthly'].get
  update:
    x-apievangelist-phrasing:
      intent: Get monthly email stats for all subusers
      effect: read
      questions:
      - What were the monthly email numbers across all my subusers?
      - Can I rank every subuser by a metric for one month?
      instructions:
      - text: Get monthly stats for all subusers for {date}.
        slots:
          date: query.date
      - text: Rank all subusers by {sort_by_metric} for the month of {date}.
        slots:
          sort_by_metric: query.sort_by_metric
          date: query.date
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/subusers/stats/sums'].get
  update:
    x-apievangelist-phrasing:
      intent: Get total email metrics across all subusers
      effect: read
      questions:
      - What are the combined totals for each email metric across my subusers?
      - Can I sum delivery metrics for every subuser over a date range?
      instructions:
      - text: Sum each email metric for all subusers since {start_date}.
        slots:
          start_date: query.start_date
      - text: Total all subuser stats from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-09-24'