Postmark
Postmark API

Aggregate outbound statistics for sends, bounces, spam complaints, opens and clicks.


Get outbound overview

GET
https://api.postmarkapp.com
/stats/outbound

Returns aggregate outbound statistics (sent, bounces, spam complaints, opens and clicks) for the period, optionally filtered by tag and stream. Statistics are available for up to one year back.

Get outbound overview › query Parameters

tag
​string

Filter by tag.

fromdate
​string · date

Return statistics starting from this date (inclusive), YYYY-MM-DD. Cannot be more than one year ago.

todate
​string · date

Return statistics up to this date (inclusive), YYYY-MM-DD.

messagestream
​string

Filter by message stream ID. Defaults to the outbound transactional stream when omitted.

Get outbound overview › Responses

Aggregate outbound statistics.

Aggregate outbound statistics for the requested period.
Sent
​integer

Total emails sent.

Example: 615
Bounced
​integer

Total bounces.

Example: 64

Total SMTP API errors.

Example: 25
BounceRate
​number

Bounce rate as a percentage.

Example: 10.406
SpamComplaints
​integer

Total spam complaints.

Example: 10
SpamComplaintsRate
​number

Spam complaint rate as a percentage.

Example: 1.626

Total opens.

Example: 166
UniqueOpens
​integer

Unique opens.

Example: 26
Tracked
​integer

Emails sent with open tracking.

Example: 111
WithClientRecorded
​integer

Opens with a recorded email client.

Example: 14
WithPlatformRecorded
​integer

Opens with a recorded platform.

Example: 10
WithReadTimeRecorded
​integer

Opens with a recorded read time.

Example: 0
TotalTrackedLinksSent
​integer

Emails sent with link tracking.

Example: 15
UniqueLinksClicked
​integer

Unique links clicked.

Example: 0
TotalClicks
​integer

Total clicks. Field of OutboundOverviewStats.

Example: 0
WithLinkTracking
​integer

Emails sent with link tracking enabled.

Example: 15
WithOpenTracking
​integer

Emails sent with open tracking enabled.

Example: 111

Get bounce counts

GET
https://api.postmarkapp.com
/stats/outbound/bounces

Returns bounce counts per day, broken down by type. Statistics are available for up to one year back.

Get bounce counts › query Parameters

tag
​string

Filter by tag.

fromdate
​string · date

Return statistics starting from this date (inclusive), YYYY-MM-DD. Cannot be more than one year ago.

todate
​string · date

Return statistics up to this date (inclusive), YYYY-MM-DD.

messagestream
​string

Filter by message stream ID. Defaults to the outbound transactional stream when omitted.

Get bounce counts › Responses

Bounce counts.

Bounce counts per day by type.
​object[]

Per-day breakdown: bounce counts per day by type.

Example: [{"Date":"2026-10-01","HardBounce":10,"SMTPApiError":2,"SoftBounce":1,"Transient":3}]
HardBounce
​integer

Total hard bounces.

Example: 100
SMTPApiError
​integer

Total SMTP API errors.

Example: 25
SoftBounce
​integer

Total soft bounces.

Example: 5
Transient
​integer

Total transient bounces.

Example: 20

Get click counts

GET
https://api.postmarkapp.com
/stats/outbound/clicks

Returns total and unique click counts per day. Statistics are available for up to one year back.

Get click counts › query Parameters

tag
​string

Filter by tag.

fromdate
​string · date

Return statistics starting from this date (inclusive), YYYY-MM-DD. Cannot be more than one year ago.

todate
​string · date

Return statistics up to this date (inclusive), YYYY-MM-DD.

messagestream
​string

Filter by message stream ID. Defaults to the outbound transactional stream when omitted.

Get click counts › Responses

Click counts.

Click counts per day.
​object[]

Per-day breakdown: click counts per day.

Example: [{"Date":"2026-10-01","TotalClicks":12,"Unique":8}]
TotalClicks
​integer

Total clicks.

Example: 90
Unique
​integer

Total unique clicks.

Example: 60

Get browser usage

GET
https://api.postmarkapp.com
/stats/outbound/clicks/browserFamilies

Returns clicks per browser family per day. Statistics are available for up to one year back.

Get browser usage › query Parameters

tag
​string

Filter by tag.

fromdate
​string · date

Return statistics starting from this date (inclusive), YYYY-MM-DD. Cannot be more than one year ago.

todate
​string · date

Return statistics up to this date (inclusive), YYYY-MM-DD.

messagestream
​string

Filter by message stream ID. Defaults to the outbound transactional stream when omitted.

Get browser usage › Responses

Browser family usage.

Clicks per browser family, per day. Property names are browser families (e.g. `Chrome`, `Safari`).
​object[]

Per-day breakdown: clicks per browser family, per day.

Example: [{"Date":"2026-10-01","Gmail":1}]
integer

Total clicks for this browser family.


Get click location

GET
https://api.postmarkapp.com
/stats/outbound/clicks/location

Returns clicks per body location (HTML or text) per day. Statistics are available for up to one year back.

Get click location › query Parameters

tag
​string

Filter by tag.

fromdate
​string · date

Return statistics starting from this date (inclusive), YYYY-MM-DD. Cannot be more than one year ago.

todate
​string · date

Return statistics up to this date (inclusive), YYYY-MM-DD.

messagestream
​string

Filter by message stream ID. Defaults to the outbound transactional stream when omitted.

Get click location › Responses

Click location counts.

Clicks per body location per day.
​object[]

Per-day breakdown: clicks per body location per day.

Example: [{"Date":"2026-10-01","HTML":10,"Text":2}]
HTML
​integer

Total HTML clicks.

Example: 80
Text
​integer

Total text clicks.

Example: 10

Get browser platform usage

GET
https://api.postmarkapp.com
/stats/outbound/clicks/platforms

Returns clicks per platform (desktop, mobile) per day. Statistics are available for up to one year back.

Get browser platform usage › query Parameters

tag
​string

Filter by tag.

fromdate
​string · date

Return statistics starting from this date (inclusive), YYYY-MM-DD. Cannot be more than one year ago.

todate
​string · date

Return statistics up to this date (inclusive), YYYY-MM-DD.

messagestream
​string

Filter by message stream ID. Defaults to the outbound transactional stream when omitted.

Get browser platform usage › Responses

Platform usage for clicks.

Clicks per platform per day.
​object[]

Per-day breakdown: clicks per platform per day.

Example: [{"Date":"2026-10-01","Desktop":8,"Mobile":6,"Unknown":1}]
Desktop
​integer

Total desktop clicks.

Example: 20
Mobile
​integer

Total mobile clicks.

Example: 30
Unknown
​integer

Total unknown clicks.

Example: 5

Get email open counts

GET
https://api.postmarkapp.com
/stats/outbound/opens

Returns total and unique open counts per day. Statistics are available for up to one year back.

Get email open counts › query Parameters

tag
​string

Filter by tag.

fromdate
​string · date

Return statistics starting from this date (inclusive), YYYY-MM-DD. Cannot be more than one year ago.

todate
​string · date

Return statistics up to this date (inclusive), YYYY-MM-DD.

messagestream
​string

Filter by message stream ID. Defaults to the outbound transactional stream when omitted.

Get email open counts › Responses

Open counts.

Open counts per day.
​object[]

Per-day breakdown: open counts per day.

Example: [{"Date":"2026-10-01","Opens":44,"Unique":17}]
Opens
​integer

Total opens.

Example: 166
Unique
​integer

Total unique opens.

Example: 26

Get email client usage

GET
https://api.postmarkapp.com
/stats/outbound/opens/emailclients

Returns opens per email client per day. Statistics are available for up to one year back.

Get email client usage › query Parameters

tag
​string

Filter by tag.

fromdate
​string · date

Return statistics starting from this date (inclusive), YYYY-MM-DD. Cannot be more than one year ago.

todate
​string · date

Return statistics up to this date (inclusive), YYYY-MM-DD.

messagestream
​string

Filter by message stream ID. Defaults to the outbound transactional stream when omitted.

Get email client usage › Responses

Email client usage.

Opens per email client, per day. Property names are client names (e.g. `Gmail`, `Outlook`).
​object[]

Per-day breakdown: opens per email client, per day.

Example: [{"Date":"2026-10-01","Gmail":1}]
integer

Total opens for this email client.


Get email platform usage

GET
https://api.postmarkapp.com
/stats/outbound/opens/platforms

Returns opens per platform (desktop, webmail, mobile) per day. Statistics are available for up to one year back.

Get email platform usage › query Parameters

tag
​string

Filter by tag.

fromdate
​string · date

Return statistics starting from this date (inclusive), YYYY-MM-DD. Cannot be more than one year ago.

todate
​string · date

Return statistics up to this date (inclusive), YYYY-MM-DD.

messagestream
​string

Filter by message stream ID. Defaults to the outbound transactional stream when omitted.

Get email platform usage › Responses

Platform usage for opens.

Opens per platform per day.
​object[]

Per-day breakdown: opens per platform per day.

Example: [{"Date":"2026-10-01","Desktop":8,"WebMail":12,"Mobile":6,"Unknown":1}]
Desktop
​integer

Total desktop opens.

Example: 20
WebMail
​integer

Total webmail opens.

Example: 40
Mobile
​integer

Total mobile opens.

Example: 30
Unknown
​integer

Total unknown opens.

Example: 5

Get sent counts

GET
https://api.postmarkapp.com
/stats/outbound/sends

Returns the number of emails sent per day. Statistics are available for up to one year back.

Get sent counts › query Parameters

tag
​string

Filter by tag.

fromdate
​string · date

Return statistics starting from this date (inclusive), YYYY-MM-DD. Cannot be more than one year ago.

todate
​string · date

Return statistics up to this date (inclusive), YYYY-MM-DD.

messagestream
​string

Filter by message stream ID. Defaults to the outbound transactional stream when omitted.

Get sent counts › Responses

Sent counts.

Sent counts per day.
​object[]

Per-day breakdown: sent counts per day.

Example: [{"Date":"2026-10-01","Sent":140}]
Sent
​integer

Total emails sent in the period.

Example: 615

Get spam complaints

GET
https://api.postmarkapp.com
/stats/outbound/spam

Returns spam complaint counts per day. Statistics are available for up to one year back.

Get spam complaints › query Parameters

tag
​string

Filter by tag.

fromdate
​string · date

Return statistics starting from this date (inclusive), YYYY-MM-DD. Cannot be more than one year ago.

todate
​string · date

Return statistics up to this date (inclusive), YYYY-MM-DD.

messagestream
​string

Filter by message stream ID. Defaults to the outbound transactional stream when omitted.

Get spam complaints › Responses

Spam complaint counts.

Spam complaints per day.
​object[]

Per-day breakdown: spam complaints per day.

Example: [{"Date":"2026-10-01","SpamComplaint":2}]
SpamComplaint
​integer

Total complaints.

Example: 10

Get tracked email counts

GET
https://api.postmarkapp.com
/stats/outbound/tracked

Returns the number of emails sent with open tracking per day. Statistics are available for up to one year back.

Get tracked email counts › query Parameters

tag
​string

Filter by tag.

fromdate
​string · date

Return statistics starting from this date (inclusive), YYYY-MM-DD. Cannot be more than one year ago.

todate
​string · date

Return statistics up to this date (inclusive), YYYY-MM-DD.

messagestream
​string

Filter by message stream ID. Defaults to the outbound transactional stream when omitted.

Get tracked email counts › Responses

Tracked email counts.

Emails sent with open tracking per day.
​object[]

Per-day breakdown: emails sent with open tracking per day.

Example: [{"Date":"2026-10-01","Tracked":24}]
Tracked
​integer

Total tracked emails.

Example: 111