bird email broadcasts list-events

Usage

Code example

bird email broadcasts list-events <broadcast-id> [flags]

Description

List the per-recipient delivery timeline for a broadcast (sends, opens, clicks, bounces, and so on), oldest first, as a cursor page. Filter by type, for example email.bounced or email.opened.

Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

Examples

Code example

bird email broadcasts list-events <broadcast-id>
bird email broadcasts list-events <broadcast-id> | jq -r '.data[].id'
bird email broadcasts list-events <broadcast-id> --limit 50 --starting-after <cursor>

Options

Pagination

Name	Description
--ending-before	Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
--limit <n>	Maximum number of items to return per page.
--starting-after	Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

Filters

Name	Description
--response-schema	Print the fields this command returns, then exit
--type	Filter by event type, for example email.bounced or email.opened. A broadcast timeline is recipient-scoped, so email.scheduled and email.canceled never appear on it; a canceled broadcast reports that in its own status. Known values: email.accepted, email.bounced, email.canceled, email.clicked, email.complained, email.deferred, email.delivered, email.list_unsubscribed, email.opened, email.out_of_band_bounce, email.processed, email.rejected, email.scheduled, email.unsubscribed (others may exist).

Name

Description

--response-schema

Print the fields this command returns, then exit

--type

Filter by event type, for example email.bounced or email.opened. A broadcast timeline is recipient-scoped, so email.scheduled and email.canceled never appear on it; a canceled broadcast reports that in its own status. Known values: email.accepted, email.bounced, email.canceled, email.clicked, email.complained, email.deferred, email.delivered, email.list_unsubscribed, email.opened, email.out_of_band_bounce, email.processed, email.rejected, email.scheduled, email.unsubscribed (others may exist).

Name	Description
bird email broadcasts cancel	Cancel a broadcast
bird email broadcasts counts	Get a broadcast's audience counts
bird email broadcasts create	Create a broadcast
bird email broadcasts delete	Delete a broadcast
bird email broadcasts get	Get a broadcast
bird email broadcasts list	List broadcasts
bird email broadcasts list-clicked-links	List a broadcast's clicked links
bird email broadcasts list-recipients	List recipients of a broadcast
bird email broadcasts send	Send a broadcast
bird email broadcasts send-quota	Get how much of a broadcast the send allowance covers
bird email broadcasts update	Update a draft or scheduled broadcast

Related resources

Continue with the documentation, guides and examples for this topic. Resources are in English.

Watch the guideGetting started with email Explore the capabilityEmail Follow the learning pathBuild your first integration Implementation guideSend your first email

Try the practice and get an implementation brief