Skip to main content
GET
Get email stats

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>.

Path Parameters

app_id
string
required

ID of the app the emails belong to.

Query Parameters

days
integer
default:30

Number of days to count, from 1 to 90, ending today in UTC. Defaults to 30. The previous totals cover the same number of days just before.

Required range: 1 <= x <= 90
limit
integer
default:50

Maximum number of entries in templates per page, from 1 to 200. Defaults to 50.

Required range: 1 <= x <= 200
cursor
string | null

next_cursor from the previous page. Send the same days and limit with it. A cursor expires after 24 hours.

Response

The app's email stats.

Delivery and engagement counts for the app's sent emails.

days
integer
required

Number of days counted, as requested.

Example:

30

templates
TemplateEmailStatsDoc · object[]
required

Counts for each template that sent email in either period, ordered by template_key.

Example:
totals
EmailStatTotalsDoc · object
required

Totals for the period across every template and emails sent without one, on every page.

previous_totals
EmailStatTotalsDoc · object | null
required

Totals for the same number of days just before the period, or null when nothing was sent then.

daily
EmailStatDayDoc · object[]
required

One entry per day of the period, oldest first, with zeros on days with no activity. Covers every template, on every page.

Example:
next_cursor
string | null
required

Pass it as cursor to get the next page of templates, or null on the last page.

Example:

"eyJuIjoiYXBwX2VtYWlsX3N0YXRzIiwicCI6eyJhZnRlciI6IldlbGNvbWUifX0"