Broadcasts

List broadcasts

Return broadcast campaigns for the current account with recipient rollup metrics.

get/v1/broadcasts

Request

  • Base URL: https://smtpfa.st/api
  • URL: https://smtpfa.st/api/v1/broadcasts
  • Auth: HTTP bearer

Query parameters

status'all' | 'draft' | 'scheduled' | 'queued' | 'sent' | 'paused' | 'canceled'

Filter by campaign status

qstring

Search by campaign name, subject, or sender

archived'false' | 'true' | 'all'

false leaves archived broadcasts out, true lists only archived ones, all lists both

Response

List of broadcasts

objectstring required
has_moreboolean required
pageinteger
page_sizeinteger
filtered_totalinteger

Broadcasts matching the status, search and archived filters

totalinteger

Every broadcast of the team that is not archived

archived_totalinteger

Archived broadcasts of the team

status_countsobject

Broadcasts that are not archived, per status

Example response

{
  "object": "list",
  "data": [
    {
      "object": "broadcast",
      "id": "clx_broadcast123",
      "name": "May product update",
      "audience": "all_contacts",
      "audience_meta": {
        "segment_id": "clx_segment123"
      },
      "from": "updates@example.com",
      "status": "draft",
      "track_opens": true,
      "track_clicks": true,
      "recipient_count": 1250,
      "metrics": {
        "total": 1250,
        "skipped": 12,
        "handed_off": 1238,
        "sent": 1238,
        "delivered": 1202,
        "opened": 714,
        "clicked": 208,
        "unsubscribed": 3,
        "bounced": 9,
        "complained": 1,
        "delivery_rate": 97.1,
        "open_rate": 59.4,
        "click_rate": 17.3,
        "unsubscribe_rate": 0.2,
        "bounce_rate": 0.7
      }
    }
  ],
  "page": 1,
  "page_size": 50,
  "filtered_total": 1,
  "total": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.