SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Statistics Categories API

4 actions 4 updates phrasing extends openapi/sendgrid-categories-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 4

$.info

$.paths['/v3/categories'].get

$.paths['/v3/categories/stats'].get

$.paths['/v3/categories/stats/sums'].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 Twilio SendGrid Statistics Categories API
  version: 1.0.0
extends: openapi/sendgrid-categories-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: 3
- target: $.paths['/v3/categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List email categories
      effect: read
      questions:
      - What categories have I tagged my emails with?
      - Can I search my categories by name?
      instructions:
      - text: List all my email categories.
      - text: Find the category named {category}.
        slots:
          category: query.category
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/categories/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get email stats per category
      effect: read
      questions:
      - How are emails in specific categories performing over time?
      - Can I compare daily stats for two categories side by side?
      instructions:
      - text: Show stats for categories {categories} since {start_date}.
        slots:
          categories: query.categories
          start_date: query.start_date
      - text: Get category stats for {categories} from {start_date} to {end_date} by {aggregated_by}.
        slots:
          categories: query.categories
          start_date: query.start_date
          end_date: query.end_date
          aggregated_by: query.aggregated_by
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/categories/stats/sums'].get
  update:
    x-apievangelist-phrasing:
      intent: Rank categories by total email stats
      effect: read
      questions:
      - Which of my categories got the most opens over a date range?
      - Can I sort all categories by a metric like clicks, highest first?
      instructions:
      - text: Total stats for every category since {start_date}.
        slots:
          start_date: query.start_date
      - text: Rank categories by {sort_by_metric} {sort_by_direction} since {start_date}.
        slots:
          sort_by_metric: query.sort_by_metric
          sort_by_direction: query.sort_by_direction
          start_date: query.start_date
      method: generated
      generated: '2026-09-24'