Email

Get email metrics

Account-wide email performance over a date range, across both send paths: 1:1 messages and broadcasts. Per-broadcast numbers stay on GET /broadcasts/{id}/stats; this is the rollup.

Two metrics are source-specific, and blending them would misreport: opened, clicked and unsubscribed are broadcast-only (1:1 mail carries no open pixel or link rewriting by design), while suppressed is 1:1-only (a broadcast drops suppressed addresses before recipient rows exist). Group by source to see them apart.

Rates are computed over sent. Grouping by broadcast returns broadcast rows only; grouping by inbox returns message rows only.

get/email/metrics

Request

  • Base URL: https://api.crevio.co/v1
  • URL: https://api.crevio.co/v1/email/metrics
  • Auth: API key in header Authorization

Query parameters

start_datestring date

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

end_datestring date

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

group_by'period' | 'source' | 'broadcast' | 'inbox'

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

granularity'hour' | 'day' | 'week' | 'month'

Bucket size when group_by=period.

source'all' | 'broadcast' | 'message'

Restrict to one send path.

timezonestring

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

Response

Email metrics for the range

object'email_metrics' required
start_datestring date required
end_datestring date required
timezonestring required
source'all' | 'broadcast' | 'message' required
group_by'period' | 'source' | 'broadcast' | 'inbox' | 'null' nullable
granularity'hour' | 'day' | 'week' | 'month'

Present only when grouping by period.

Changes

No recorded changes to this operation across all 2 revisions of this API.