Brevo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Brevo Transactional SMS SMS Statistics API

4 actions 4 updates phrasing extends openapi/brevo-sms-statistics-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Brevo's API. It is a proposal applied on top of the contract, not a document Brevo publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/transactionalSMS/statistics/events'].get

$.paths['/transactionalSMS/statistics/reports'].get

$.paths['/transactionalSMS/statistics/aggregatedReport'].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 Brevo Transactional SMS SMS Statistics API
  version: 1.0.0
extends: openapi/brevo-sms-statistics-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/transactionalSMS/statistics/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List transactional SMS events
      effect: read
      questions:
      - Was a transactional text to a specific phone number delivered?
      - Can I list only the bounced transactional SMS events?
      instructions:
      - text: List transactional SMS events for {phoneNumber}.
        slots:
          phoneNumber: query.phoneNumber
      - text: Show {event} SMS events between {startDate} and {endDate}.
        slots:
          event: query.event
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transactionalSMS/statistics/reports'].get
  update:
    x-apievangelist-phrasing:
      intent: Get daily transactional SMS stats
      effect: read
      questions:
      - How many transactional texts were delivered each day this week?
      - Can I get per-day SMS delivery stats for a single tag?
      instructions:
      - text: Show per-day transactional SMS stats for the last {days} days.
        slots:
          days: query.days
      - text: Give me daily SMS delivery numbers for tag {tag} from {startDate} to {endDate}.
        slots:
          tag: query.tag
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transactionalSMS/statistics/aggregatedReport'].get
  update:
    x-apievangelist-phrasing:
      intent: Get total transactional SMS stats for a period
      effect: read
      questions:
      - What's my total number of transactional texts sent and bounced this month?
      - Can I get one overall SMS total for a tag?
      instructions:
      - text: Get aggregated transactional SMS totals from {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      - text: Sum up SMS sent, delivered and bounced for tag {tag} over {days} days.
        slots:
          tag: query.tag
          days: query.days
      method: generated
      generated: '2026-09-26'