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.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Reference Ad Network Reports API
version: 1.0.0
extends: openapi/beehiiv-ad-network-reports-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['/publications/{publicationId}/ad_network/reports'].get
update:
x-apievangelist-phrasing:
intent: List ad performance and payment reports
effect: read
questions:
- Where can I see per-ad performance and payment reports for my newsletter?
- Can I pull ad network reports for just last month's date range?
- How much did each individual ad placement earn me?
instructions:
- text: List ad network reports for publication {publication} between {start_date} and {end_date}.
slots:
publication: path.publicationId
start_date: query.start_date
end_date: query.end_date
- text: Show page {page} of the ad payment reports for {publication}.
slots:
page: query.page
publication: path.publicationId
method: generated
generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/ad_network/reports/summaries'].get
update:
x-apievangelist-phrasing:
intent: Summarize ad revenue for one publication
effect: read
questions:
- What is the total ad revenue for one of my newsletters this quarter?
- Can I get a single aggregate of ad performance for one publication?
instructions:
- text: Summarize ad network revenue and performance for publication {publication}.
slots:
publication: path.publicationId
- text: Give me the ad revenue total for {publication} from {start_date} to {end_date}.
slots:
publication: path.publicationId
start_date: query.start_date
end_date: query.end_date
method: generated
generated: '2026-09-26'
- target: $.paths['/ad_network/reports/summaries'].get
update:
x-apievangelist-phrasing:
intent: Summarize ad revenue across all publications
effect: read
questions:
- How much ad revenue did my whole account earn across every newsletter?
- Is there an account-wide rollup of ad network performance for all my publications?
instructions:
- text: Show my account-wide ad network summary across all publications.
- text: Total the ad revenue across every publication I own from {start_date} to {end_date}.
slots:
start_date: query.start_date
end_date: query.end_date
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.