TEASEDocs
API ReferenceInbox & Broadcasts

Preview a broadcast audience

Estimates how many fans an audience selector matches before scheduling, returning matched/selected counts and a non-PII distribution. Does not create or send anything. Requires a read-scoped key.

Authorization

bearerAuth
AuthorizationBearer <token>

Your al_live_<prefix>_<secret> API key. Mint and manage keys in the dashboard.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

POST
/api/admin/broadcasts/preview
curl -X POST "https://example.com/api/admin/broadcasts/preview" \  -H "Content-Type: application/json" \  -d '{    "audience": {      "tier": "whales",      "status": "active"    }  }'
{  "matched": 1240,  "selected": 1000,  "histogram": {    "whale": 120,    "regular": 640,    "new": 240  }}
{  "detail": "Not authenticated"}