Brevo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Brevo Transactional Email Email Activity API

3 actions 3 updates phrasing extends openapi/brevo-email-activity-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 3

$.info

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

$.paths['/smtp/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 Email Email Activity API
  version: 1.0.0
extends: openapi/brevo-email-activity-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: 2
- target: $.paths['/smtp/statistics/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List individual transactional email events
      effect: read
      questions:
      - Did a specific customer open the transactional email we sent them?
      - Can I list only spam reports for a given template?
      instructions:
      - text: List transactional email events for {email}.
        slots:
          email: query.email
      - text: Show {event} events for template {templateId} from {startDate} to {endDate}.
        slots:
          event: query.event
          templateId: query.templateId
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/smtp/statistics/aggregatedReport'].get
  update:
    x-apievangelist-phrasing:
      intent: Get transactional email totals for a period
      effect: read
      questions:
      - What are my total transactional deliveries, opens and clicks for last month?
      - How many transactional emails bounced overall in a date range?
      instructions:
      - text: Get aggregated transactional email stats from {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      - text: Show my overall transactional email totals.
      method: generated
      generated: '2026-09-26'