Campaigns
List a broadcast's recipients, outcomes, and engagement
Per-recipient outcome (queued, sending, sent, held, skipped with a reason, or failed with the error), the email ID for delivery events, the inbox provider, and delivery, open, click, bounce, complaint, and unsubscribe times. Filter by status, by activity (opened, clicked, not_opened, not_delivered, bounced, complained, unsubscribed), or by an email substring in query. include=links (implied by activity=clicked) adds the links each recipient clicked. Opens are estimates and bot-filtered; they never prove that someone read the message.
get/broadcasts/{id}/recipients
Request
- Base URLhttps://sendhq.cc/api/v1
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring required
Query parameters
status'queued' | 'sending' | 'sent' | 'held' | 'skipped' | 'failed'
activity'opened' | 'clicked' | 'not_opened' | 'not_delivered' | 'bounced' | 'complained' | 'unsubscribed'
querystring
include'links'
limitinteger
offsetinteger
Response
Successful response
Changes
No recorded changes to this operation across all 1 revision of this API.