Sign inGet Started

bird email inbox-insights placement

Usage

Code example
bird email inbox-insights placement <sending-domain> [flags]

Description

Read placement for a verified domain owned by the workspace. Dates are inclusive UTC days, with at most 30 days between from and to. Rates are percentages, and section statuses distinguish missing measurements. Deltas require a requested comparison and comparable prior data; absence does not mean stable placement. Provider filters add series lines without filtering the provider table. The response reports domain-wide panel/seed estimates with audience weighting, not delivery counts or a marketing/transactional split; a domain name alone does not identify a stream. Read rate measures reading, not opens. Label freshness from freshness.as_of; missing days and nulls are not zeros. Associations do not establish a cause. This read does not enable monitoring. Individual seed-test results and Google Postmaster connection status are dashboard-only; these aggregates cannot substitute for a particular test or prove placement for every customer.

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

Examples

Code example
bird email inbox-insights placement <sending-domain>

Options

NameDescription
--compareInclude the prior equal-length period, populating compared_to and every delta field. Possible values: previous_period.
--fromFirst UTC day of the period, inclusive, in YYYY-MM-DD: the same window convention as the email statistics endpoints, so figures from the two sources cover the same days. Defaults to 30 days before to. It may be at most 30 days before to, which is also the default, so a request naming neither date is already at the limit. Asking for more answers 422: the page pairs these figures with Bird's own per-provider sending statistics, and those are kept for 30 days, so a longer period could only describe two different spans side by side.
--group-byBucket size for the series. Defaults to day. Possible values: day, week, month.
--include-ip-detailsInclude per-IP placement detail for the domain's sending infrastructure. Off by default; only the sending-infrastructure view needs it.
--response-schemaPrint the fields this command returns, then exit
--series-providers <value>…Providers to break the series down by, named as the provider table names them. Each named provider adds one series line; without this, the series carries the domain-wide line only. The provider table is never filtered by this parameter.
--toLast UTC day of the period, inclusive, in YYYY-MM-DD. Defaults to today.
NameDescription
bird email inbox-insights authenticationGet email authentication standing for a sending domain
bird email inbox-insights blocklistsCheck whether a sending domain's infrastructure is blocklisted
bird email inbox-insights complaintsGet the Google-reported spam rate for a sending domain
bird email inbox-insights spam-trapsGet spam-trap hits for a sending domain

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