Skip to main content
GET
Retrieve broadcast stats

Authorizations

x-api-key
string
header
required

Unified API key for server-side SDK and API integrations

Path Parameters

id
string<uuid>
required

Broadcast id.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Default Response

broadcastId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
totalRecipients
integer
required
Required range: 0 <= x <= 9007199254740991
sent
integer
required
Required range: 0 <= x <= 9007199254740991
delivered
integer
required
Required range: 0 <= x <= 9007199254740991
opened
integer
required
Required range: 0 <= x <= 9007199254740991
clicked
integer
required
Required range: 0 <= x <= 9007199254740991
bounced
integer
required
Required range: 0 <= x <= 9007199254740991
complained
integer
required
Required range: 0 <= x <= 9007199254740991
failed
integer
required
Required range: 0 <= x <= 9007199254740991
skipped
integer
required
Required range: 0 <= x <= 9007199254740991
deliveryRate
number
required
Required range: x >= 0
openRate
number
required
Required range: x >= 0
clickRate
number
required
Required range: x >= 0
bounceRate
number
required
Required range: x >= 0
complaintRate
number
required
Required range: x >= 0