Skip to main content
GET
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Query Parameters

start_date
string<date>

Inclusive first day, YYYY-MM-DD. Defaults to 7 days before end_date.

end_date
string<date>

Inclusive last day, YYYY-MM-DD. Defaults to today.

group_by
enum<string>

Dimension to break the range down by. Omit for totals only.

Available options:
period,
source,
broadcast,
inbox
granularity
enum<string>
default:day

Bucket size when group_by=period.

Available options:
hour,
day,
week,
month
source
enum<string>
default:all

Restrict to one send path.

Available options:
all,
broadcast,
message
timezone
string

IANA timezone the day and period boundaries are computed in. Defaults to UTC.

Response

Email metrics for the range

object
enum<string>
required
Available options:
email_metrics
start_date
string<date>
required
end_date
string<date>
required
timezone
string
required
source
enum<string>
required
Available options:
all,
broadcast,
message
totals
object
required
data
object[]
required

Per-group rows. Empty when group_by is omitted — totals is the whole answer.

group_by
enum<string> | null
Available options:
period,
source,
broadcast,
inbox,
null
granularity
enum<string>

Present only when grouping by period.

Available options:
hour,
day,
week,
month