Sign inGet started

bird email inbox-insights spam-traps

Usage

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

Description

Read spam-trap hits for a verified domain owned by the workspace, with totals, trap kinds, networks and individual hits. Dates are inclusive UTC days with at most 30 days between from and to; compare=previous_period includes the preceding period. A measured zero is a valid result. Use the response status to distinguish measurements from unavailable data.
API-key calls require Insights preview access for your organization.

Examples

Code example
bird email inbox-insights spam-traps <sending-domain>

Options

NameDescription
--compareInclude the prior equal-length period, populating compared_to and delta. Possible values: previous_period.
--fromFirst UTC day of the period, inclusive, in YYYY-MM-DD: the same window convention as the email statistics endpoints. 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.
--response-schemaPrint the fields this command returns, then exit
--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 placementGet inbox placement for a sending domain