Broadcasts

Retrieve broadcast stats

Returns delivery and engagement stats for a single broadcast. The same object is embedded as stats on the broadcast itself; this endpoint exists for callers that only want to poll progress.

get/broadcasts/{id}/stats

Request

  • Base URL: https://api.crevio.co/v1
  • URL: https://api.crevio.co/v1/broadcasts/{id}/stats
  • Auth: API key in header Authorization

Path parameters

idstring required

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

Response

Broadcast stats

object'broadcast_stats' required
broadcaststring required

The broadcast's prefixed id.

recipientsinteger required

Size of the resolved audience.

sentinteger required

Handed to the email provider.

deliveredinteger required
bouncedinteger required
complainedinteger required

Marked as spam by the recipient.

failedinteger required
openedinteger required

Distinct recipients who opened.

clickedinteger required

Distinct recipients who clicked a link.

unsubscribedinteger required
delivery_ratenumber required
open_ratenumber required
click_ratenumber required
bounce_ratenumber required
unsubscribe_ratenumber required
progressnumber required

Percentage of the audience already handed to the provider.

status'draft' | 'scheduled' | 'sending' | 'sent' | 'canceled' | 'failed' required

Changes

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