beehiiv · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference Engagements API

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

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/publications/{publicationId}/engagements'].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 Reference Engagements API
  version: 1.0.0
extends: openapi/beehiiv-engagements-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: 1
- target: $.paths['/publications/{publicationId}/engagements'].get
  update:
    x-apievangelist-phrasing:
      intent: Get email engagement metrics over time
      effect: read
      questions:
      - What were my newsletter's opens and clicks per day last week?
      - Can I break engagement down by week instead of by day?
      - What is the longest date range I can request engagement metrics for?
      instructions:
      - text: Show email engagement for publication {publication} for {number_of_days} days starting {start_date}.
        slots:
          publication: path.publicationId
          number_of_days: query.number_of_days
          start_date: query.start_date
      - text: Get {granularity} engagement metrics for {email_type} emails on {publication}.
        slots:
          granularity: query.granularity
          email_type: query.email_type
          publication: path.publicationId
      method: generated
      generated: '2026-09-26'