v4

OpenAPI 3.0.02026-07-31257282489.4 KB
Statistics

Get email overview statistics. Pass outboundId (query) to restrict the statistics to a single outbound campaign.

get/statistics/email-overview

Query parameters

timezonestring
  • Timezone for date calculations
groupInterval'day' | 'month' | 'year'
skipnumber double
limitnumber double
groupedBystring
aggsTypestring
startDatestring
  • Required. Start date (YYYY-MM-DD), forwarded to the email provider as the report range
endDatestring
  • Required. End date (YYYY-MM-DD), forwarded to the email provider as the report range
createdAtstring
updatedAtstring
emailServerKeystring
  • Ignored; the server key is resolved from the project's email settings.

Response

Ok

{"stackTrail":"paths:/statistics/email-overview:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}