Skip to main content
GET
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Path Parameters

id
string
required

The broadcast's prefixed id (e.g. bcst_abc123).

Response

Broadcast stats

Delivery and engagement rollup for a broadcast. Rates are fractions of sent (a recipient never handed to the provider can't have opened anything).

object
enum<string>
required
Available options:
broadcast_stats
broadcast
string
required

The broadcast's prefixed id.

recipients
integer
required

Size of the resolved audience.

sent
integer
required

Handed to the email provider.

delivered
integer
required
bounced
integer
required
complained
integer
required

Marked as spam by the recipient.

failed
integer
required
opened
integer
required

Distinct recipients who opened.

clicked
integer
required

Distinct recipients who clicked a link.

unsubscribed
integer
required
delivery_rate
number
required
open_rate
number
required
click_rate
number
required
bounce_rate
number
required
unsubscribe_rate
number
required
progress
number
required

Percentage of the audience already handed to the provider.

status
enum<string>
required
Available options:
draft,
scheduled,
sending,
sent,
canceled,
failed