Postmark · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Postmark Outbound API
11 actions
11 updates
phrasing
extends
openapi/postmark-outbound-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Postmark's API. It is a proposal applied on top of the contract, not a document Postmark publishes.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/stats/outbound/clicks'].get
$.paths['/stats/outbound/clicks/platforms'].get
$.paths['/stats/outbound/opens'].get
$.paths['/stats/outbound/opens/platforms'].get
$.paths['/stats/outbound/opens/readtimes'].get
$.paths['/stats/outbound'].get
$.paths['/stats/outbound/bounces'].get
$.paths['/stats/outbound/sends'].get
$.paths['/stats/outbound/spam'].get
$.paths['/stats/outbound/tracked'].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 Postmark Outbound API
version: 1.0.0
extends: openapi/postmark-outbound-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 10
- target: $.paths['/stats/outbound/clicks'].get
update:
x-apievangelist-phrasing:
intent: Count link clicks per day
effect: read
questions:
- How many link clicks did my emails get each day?
- What's the daily click volume on messages with one tag?
instructions:
- text: Show daily click counts since {fromdate}.
slots:
fromdate: query.fromdate
- text: Count total and unique clicks for tag {tag} through {todate}.
slots:
tag: query.tag
todate: query.todate
method: generated
generated: '2026-10-01'
- target: $.paths['/stats/outbound/clicks/platforms'].get
update:
x-apievangelist-phrasing:
intent: Break down link clicks by device platform
effect: read
questions:
- Do people click my email links more from phones or desktops?
- What platform split do link clicks show over a date range?
instructions:
- text: Break down link clicks by mobile versus desktop from {fromdate} to {todate}.
slots:
fromdate: query.fromdate
todate: query.todate
- text: Show the click platform mix for tag {tag}.
slots:
tag: query.tag
method: generated
generated: '2026-10-01'
- target: $.paths['/stats/outbound/opens'].get
update:
x-apievangelist-phrasing:
intent: Count email opens per day
effect: read
questions:
- How many opens and unique opens did my emails get each day?
- What's the open trend for a specific tag over time?
instructions:
- text: Show daily open counts since {fromdate}.
slots:
fromdate: query.fromdate
- text: Count total and unique opens for tag {tag} up to {todate}.
slots:
tag: query.tag
todate: query.todate
method: generated
generated: '2026-10-01'
- target: $.paths['/stats/outbound/opens/platforms'].get
update:
x-apievangelist-phrasing:
intent: Break down opens by device platform
effect: read
questions:
- Are my emails opened more on mobile, desktop or webmail?
- What platform split do opens show for one tag?
instructions:
- text: Break down email opens by mobile, desktop and webmail since {fromdate}.
slots:
fromdate: query.fromdate
- text: Show the open platform mix for tag {tag}.
slots:
tag: query.tag
method: generated
generated: '2026-10-01'
- target: $.paths['/stats/outbound/opens/readtimes'].get
update:
x-apievangelist-phrasing:
intent: See how long recipients spend reading emails
effect: read
questions:
- How long do recipients spend reading my emails after opening them?
- What's the read-time breakdown for messages with one tag?
instructions:
- text: Show email read times from {fromdate} to {todate}.
slots:
fromdate: query.fromdate
todate: query.todate
- text: Break down how long readers spent on emails tagged {tag}.
slots:
tag: query.tag
method: generated
generated: '2026-10-01'
- target: $.paths['/stats/outbound'].get
update:
x-apievangelist-phrasing:
intent: Get an overview of outbound email stats
effect: read
questions:
- How is my outbound email performing overall this month?
- Can I get a single summary of sends, bounces, spam and opens for a tag?
instructions:
- text: Give me the outbound stats overview from {fromdate} to {todate}.
slots:
fromdate: query.fromdate
todate: query.todate
- text: Summarize all outbound performance for tag {tag}.
slots:
tag: query.tag
method: generated
generated: '2026-10-01'
- target: $.paths['/stats/outbound/bounces'].get
update:
x-apievangelist-phrasing:
intent: Count bounces per day by type
effect: read
questions:
- How many hard and soft bounces did I get each day?
- Is my bounce volume trending up over a date range?
instructions:
- text: Show daily bounce counts from {fromdate} to {todate}.
slots:
fromdate: query.fromdate
todate: query.todate
- text: Chart bounce totals for messages tagged {tag}.
slots:
tag: query.tag
method: generated
generated: '2026-10-01'
- target: $.paths['/stats/outbound/sends'].get
update:
x-apievangelist-phrasing:
intent: Count emails sent per day
effect: read
questions:
- How many emails did I send each day last week?
- What's my daily send volume for a particular tag?
instructions:
- text: Show daily sent counts since {fromdate}.
slots:
fromdate: query.fromdate
- text: Count the emails sent with tag {tag} up to {todate}.
slots:
tag: query.tag
todate: query.todate
method: generated
generated: '2026-10-01'
- target: $.paths['/stats/outbound/spam'].get
update:
x-apievangelist-phrasing:
intent: Count spam complaints per day
effect: read
questions:
- How many recipients marked my emails as spam?
- Are spam complaints rising for one of my email campaigns?
instructions:
- text: Show spam complaint counts since {fromdate}.
slots:
fromdate: query.fromdate
- text: Count spam complaints on email tagged {tag}.
slots:
tag: query.tag
method: generated
generated: '2026-10-01'
- target: $.paths['/stats/outbound/tracked'].get
update:
x-apievangelist-phrasing:
intent: Count emails sent with tracking enabled
effect: read
questions:
- How many of my emails went out with open or link tracking turned on?
- What share of a tag's messages were tracked?
instructions:
- text: Show the tracked email counts from {fromdate} to {todate}.
slots:
fromdate: query.fromdate
todate: query.todate
- text: Count tracked emails with tag {tag}.
slots:
tag: query.tag
method: generated
generated: '2026-10-01'