bird email inbox-insights complaints
Usage
Code example
bird email inbox-insights complaints <sending-domain> [flags]Description
Read the Google Postmaster spam rate for a verified domain owned by the workspace. This percentage covers Gmail-received mail, not Bird feedback-loop complaints across providers. Dates are inclusive UTC days with at most 30 days between from and to. Use group_by for the series grain and compare=previous_period for the preceding period. Sections can report not_configured when Google Postmaster setup is incomplete.
API-key calls require Insights preview access for your organization.
Examples
Code example
bird email inbox-insights complaints <sending-domain>Options
| Name | Description |
|---|---|
| --compare | Include the prior equal-length period, populating compared_to and the rate's delta. Possible values: previous_period. |
| --from | First 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. |
| --group-by | Bucket size for the series. Defaults to day. Possible values: day, week, month. |
| --response-schema | Print the fields this command returns, then exit |
| --to | Last UTC day of the period, inclusive, in YYYY-MM-DD. Defaults to today. |
Related
| Name | Description |
|---|---|
| bird email inbox-insights authentication | Get email authentication standing for a sending domain |
| bird email inbox-insights blocklists | Check whether a sending domain's infrastructure is blocklisted |
| bird email inbox-insights placement | Get inbox placement for a sending domain |
| bird email inbox-insights spam-traps | Get spam-trap hits for a sending domain |
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 integrationImplementation guideSend your first email
Get an implementation brief