bird email broadcasts list
Usage
代码示例
bird email broadcasts list [flags]Description
List broadcasts in the workspace, newest first. Filter by lifecycle status, audience_id, or tag, search tag names/values with q, or narrow to a window with created_after/created_before. Use bird email broadcasts get for full detail on one broadcast.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.
Examples
代码示例
bird email broadcasts list
bird email broadcasts list | jq -r '.data[].id'
bird email broadcasts list --limit 50 --starting-after <cursor>Options
Filters
| Name | Description |
|---|---|
--audience-id | Filter by audience. Only broadcasts that use this audience are returned. |
--created-after | Limits the response to resources created at or after this timestamp. Combine it with created_before to select a time window. Use an RFC 3339 timestamp with a timezone offset. |
--created-before | Limits the response to resources created before this timestamp. Combine it with created_after to select a time window. Use an RFC 3339 timestamp with a timezone offset. |
--q | Case-insensitive literal substring match against the broadcast's tags or the referenced template's name. With email_management read access, also matches the subject in the effective language of the template version resolved when this broadcast's execution starts. Draft and scheduled broadcasts have no execution subject to search. Percent signs, underscores, and backslashes are literal characters. |
--response-schema | Print the fields this command returns, then exit |
--status <value>… | Filter by lifecycle status. Repeat the parameter to match more than one status, for example ?status=accepted&status=sending. Possible values: draft, scheduled, accepted, sending, sent, canceling, canceled, failed. |
--tag | Filter by tag. Pass name to match any broadcast that has that tag name, or pass name:value to match a specific tag pair, for example campaign:spring_launch. |
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. Allowed range: 1 to 100. |
--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. |
Related
| 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-clicked-links | List a broadcast's clicked links |
bird email broadcasts list-events | List events for a broadcast |
bird email broadcasts list-recipients | List recipients of a broadcast |
bird email broadcasts send | Send a broadcast |
bird email broadcasts send-quota | Get the email send allowance for a broadcast |
bird email broadcasts update | Update a draft or scheduled broadcast |