v1

latestOpenAPI 3.1.02026-07-2670105729.6 KB
Analytics

Get email sends

Unified send read. A send is the unit of delivery + analytics: one design delivered to a target (audience, inline list, or single address) via one domain. Omit sendId to LIST the brand’s sends, newest first, under { data, pagination }; filter with ?status= (scheduled | queued | sending | sent | failed | canceled), the from/to ISO-8601 window, or ?emailId= (one design’s sends). Pass ?sendId= to fetch ONE — returns { data: [row] } (no pagination), 404 SEND_NOT_FOUND on an unknown / cross-brand id; add ?include=events (detail only) for a bounded first page of the send’s analytics events. sendId and emailId are mutually exclusive.

get/v1/analytics/sends

Query parameters

sendIdstring

Fetch a single send by id (detail mode → { data: [row] }). Omit to list.

emailIdstring

List mode — narrow to one design’s sends. Mutually exclusive with sendId.

include'events'

Detail-only expansion: events inlines a bounded first page of the send’s analytics events. Rejected without sendId.

status'scheduled' | 'queued' | 'sending' | 'paused' | 'sent' | 'failed' | 'canceled'
fromstring date-time
tostring date-time
limitinteger

Page size (1–100). Defaults to 100.

cursorstring

Opaque pagination cursor echoed from the previous page’s pagination.cursor. Omit for the first page.

Response

A page of sends (list mode), or { data: [row] } (detail mode; events[] present when ?include=events).