bird email competitive watchlist brands campaigns list

Usage

Code example

bird email competitive watchlist brands campaigns list <watchlist-brand-id> [flags]

Takes a watchlist_brand_id from bird email competitive watchlist get. Returns a cursor page, default 25 rows and maximum 100. Cursors retain the brand, range and ordering: next_cursor advances with starting_after; prev_cursor or refresh_cursor reads preceding rows with ending_before. captured and promo_rate describe a sample independently of this page. next_cursor controls continuation; truncated can also describe the sample.

API-key calls require Insights preview access for your organization.

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

Examples

Code example

bird email competitive watchlist brands campaigns list <watchlist-brand-id>
bird email competitive watchlist brands campaigns list <watchlist-brand-id> | jq -r '.data[].id'
bird email competitive watchlist brands campaigns list <watchlist-brand-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.
--order	Sort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field. Possible values: asc, desc.
--sort	Field to sort campaigns by. Possible values: sent_at.
--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
--range <n>	How many days back the response covers, counting from now. One of three fixed trend windows rather than an open date range, matching how a competitive-intelligence chart is read. Defaults to 30. Possible values: 7, 30, 90.
--response-schema	Print the fields this command returns, then exit

Name	Description
bird email competitive watchlist brands campaigns get	Get one campaign a watched brand sent

Related resources

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

Understand the conceptShould I use a Bird SDK or call the API directly?Follow the learning pathBuild your first integration Implementation guideSend your first email

Get an implementation brief