Lettermint Team API

Query recipient metrics, time series, and grouped results for your team.


Query email analytics

POST
https://api.lettermint.co/v1
/analytics
Bearer

Returns event-time recipient metrics, rates with their denominators, latency percentiles, and optional time series and grouped results. Requires the Pro plan and analytics feature flag. Personal message dimensions also require message-read access.

Query email analytics › Headers

Authorization
​string · required

Bearer token. Format: Bearer {team_token}

Query email analytics › Request Body

metrics
​string[] · minItems: 1 · required

Every count is attributed to the time its event occurred, so a message accepted in one bucket can be delivered in the next. Delivery outcomes happen once per recipient, so their event counts equal recipient counts. messages counts accepted messages; mta_accepted and attempted_recipients count recipients the MTA received. Under provider, infrastructure and diagnosis dimensions, sent/attempted count delivery attempts: mta_accepted and attempted_recipients equal delivery_attempts when a query groups or filters by provider_family, provider_subtype, dedicated_ip, dedicated_pool_id, infrastructure_state or an SMTP diagnosis dimension, because the MTA assigns those values at the delivery attempt; the other lifecycle metrics return null there, and a breakdown by those dimensions omits the unknown group. deferred_recipients counts recipients delayed on the first attempt; deferred_events counts every deferral. delivery_attempts counts delivered, deferred and in-band bounced attempts. transport_outcome_recipients = delivered + bounced + soft_bounced. effective_delivered = delivered minus out-of-band bounces in the same period and can be negative for a single bucket or group. Engagement counts per class are unique per recipient, counted when the first qualifying open or click occurred; _events variants count every observation. Rates are fractions; zero denominators return null, and event-time rates can exceed 1. Latency percentiles are milliseconds read from log-scale histograms (error below 15 percent); _samples returns the sample count. Personal message dimensions support daily buckets over the message retention period. delivery_rate = delivered / transport_outcome_recipients. effective_delivery_rate = effective_delivered / transport_outcome_recipients. bounce_rate = bounced / transport_outcome_recipients. deferral_rate = deferred_events / delivery_attempts. complaint_rate = complained / delivered. human_open_rate = human_opens / open_tracked_delivered. human_click_rate = human_clicks / click_tracked_delivered.

Enum values:
accepted
processed
suppressed
policy_rejected
application_failed
mta_accepted
canceled
messages
from
​string

Inclusive calendar date or RFC 3339 instant. Default: 30 calendar days including today. Instants are aligned outward to whole UTC hours, or whole UTC days when from_address or subject is grouped or filtered; meta.from, meta.to, meta.effective_to and meta.alignment report the exact window used.

to
​string

Inclusive calendar date or exclusive RFC 3339 instant. Maximum window: 90 days. Instants are aligned outward to whole UTC hours, or whole UTC days when from_address or subject is grouped or filtered; meta.from, meta.to, meta.effective_to and meta.alignment report the exact window used.

timezone
​string

IANA time zone. Default: UTC.

include
​string[]
Enum values:
summary
time_series
breakdown
group_by
​string[] · maxItems: 3
​object[] · maxItems: 20
interval
​string · enum
Enum values:
hour
day
compare
​string · enum
Enum values:
previous_period
include_trend
​boolean
​object
limit
​integer · min: 1 · max: 200
cursor
​string

Repeat the same query with this cursor. It expires within 60 seconds.

Query email analytics › Responses

Analytics results. All selected sections share the same access scope and time window. Instants are aligned outward to whole UTC hours, or whole UTC days when from_address or subject is grouped or filtered; meta.from, meta.to, meta.effective_to and meta.alignment report the exact window used.

​object · required
​object · required
​object · required