Skip to main content
GET
curl

Authorizations

Authorization
string
header
required

A key generated from Settings → Developers, sent as Authorization: Bearer dr_live_<12 hex chars>_<64 hex chars>. Keys carry explicit scopes — each endpoint states the one it requires. The full key is shown exactly once at generation time and cannot be retrieved again; only the keyId prefix is shown afterward. A revoked key fails auth on its very next request.

Path Parameters

id
string<uuid>
required

The broadcast id from GET /api/preview/email/broadcasts.

Response

The broadcast's aggregate numbers.

Aggregate delivery numbers for one broadcast. No recipient-level data.

broadcastId
string<uuid>
required

The broadcast's id.

sent
integer
required

Number of sends recorded for this broadcast, whatever their status (including suppressed, failed and bounced sends); not only messages that reached the provider.

delivered
integer
required

Recorded sends whose status is delivered, opened, clicked or complained (a count of sends, not unique recipients).

opened
integer
required

Unique recipient addresses with an open or a click recorded.

clicked
integer
required

Unique recipient addresses that clicked a content link (an unsubscribe-only click does not count). For broadcasts sent before 2026-05-17, any recorded click counts.

bounced
integer
required

Recorded sends with status bounced.

deliveredRate
number
required

delivered / sent, 0 to 1, four decimals.

openedRate
number
required

opened / delivered, 0 to 1, four decimals.

clickedRate
number
required

clicked / delivered, 0 to 1, four decimals.

bouncedRate
number
required

bounced / sent, 0 to 1, four decimals.