OverviewProductsPlatformsAPI ReferenceResources
Broadcasts

List broadcasts

GEThttps://zernio.com/api/v1/broadcasts

Returns broadcasts with delivery stats. Filter by status, platform, or profile.

Authentication

AuthorizationBearer tokenRequired

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

Query parameters

Optional
profileIdstring

Filter by profile. Omit to list across all profiles

statusstringOne of draft | scheduled | sending | completed | failed | cancelled
platformstring
limitintegerDefault 50
skipintegerDefault 0

Responses

Success· the request worked

Errors· the request failed

GET/v1/broadcasts
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.broadcasts.listBroadcasts();console.log(data);
{  "success": true,  "broadcasts": [    {      "id": "string",      "name": "string",      "description": "string",      "platform": "string",      "accountId": "string",      "accountName": "string",      "status": "draft",      "messagePreview": "string",      "scheduledAt": "2019-08-24T14:15:22Z",      "startedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z",      "recipientCount": 0,      "sentCount": 0,      "deliveredCount": 0,      "readCount": 0,      "failedCount": 0,      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "pagination": {    "total": 0,    "limit": 0,    "skip": 0,    "hasMore": true  }}
OpenAPI specification
Was this page helpful?