Sign inGet Started

bird email seeding runs list

Usage

Code example
bird email seeding runs list [flags]

Description

Read retained sending progress. For a known run ID, use bird email seeding runs get directly. Otherwise filter by the original email or broadcast and follow cursors with the same filters. No settings read is required. An empty page establishes only that this response has no retained matching record. Reads can lag, history can expire, or no run may exist; absence cannot distinguish these causes or establish whether seeding ever started or delivered. Do not resend based on absence. Provider acceptance, delivery, and inbox placement are separate outcomes. Domain-level placement measurements are not run results. trigger_rotated can reflect disabling settings; re-enabling does not advance the cancellation generation or resume fenced copies. The reason proves neither an address change nor that it stayed unchanged. An unchanged integration configuration does not establish Bird's current trigger.

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

Procedure

Step 2 of 3 of "Inspect Automatic Email Seeding activity". Previous: bird email seeding sources list. Next: bird email seeding runs get.

Examples

Code example
bird email seeding runs list
bird email seeding runs list | jq -r '.data[].id'
bird email seeding runs list --limit 50 --starting-after <cursor>

Options

Filters

NameDescription
--created-afterLimits 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-beforeLimits 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.
--response-schemaPrint the fields this command returns, then exit
--sending-domainMatch the exact sending domain recorded during registration.
--source-broadcast-idMatch an original broadcast. Cannot be combined with source_email_id. If source_kind is supplied, it must be broadcast; conflicting combinations return 422.
--source-email-idMatch an original email. Cannot be combined with source_broadcast_id or source_kind=broadcast; either combination returns 422.
--source-kindMatch the original source kind. Possible values: api, smtp, scheduled, broadcast.
--stateMatch the current derived execution state. Possible values: pending, registering, registration_uncertain, ready, dispatching, dispatch_complete, stopped, failed.

Pagination

NameDescription
--ending-beforeCursor 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.
--include-totalWhen true, the response includes a total field with the total number of items matching the request's filters across all pages.
--limit <n>Maximum number of items to return per page. Allowed range: 1 to 100.
--orderSort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field. Possible values: asc, desc.
--sortField to sort by. Possible values: created_at.
--starting-afterCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
NameDescription
bird email seeding runs cancelCancel an automatic seeding run
bird email seeding runs getGet an automatic seeding run

Continue with the documentation, guides and examples for this topic.