Sign inGet Started

Get the Google-reported spam rate for a sending domain

GET
/v1/email/inbox-insights/complaints
// Requires Insights preview access for the organization.
let sendingDomain: string | undefined;
for await (const domain of bird.email.inboxInsights.domains.list({ search: "mail.example.com" })) {
  if (domain.domain === "mail.example.com") { sendingDomain = domain.domain; break; }
}
if (!sendingDomain) throw new Error("Verify mail.example.com in this workspace first");
const report = await bird.email.inboxInsights.complaints({ sending_domain: sendingDomain });
console.log(report);
Antwort200
{
  "resource": "placement",
  "domain": "mail.acme.com",
  "measurement": {
    "sources": [
      "panel",
      "intelliseed_public"
    ],
    "weighting": {
      "weight_set_id": "12",
      "source": "account",
      "basis": "weighted-mean-of-per-isp-rates"
    }
  },
  "generated_at": "2026-08-18T09:34:00Z",
  "freshness": {
    "as_of": "2026-08-17",
    "lag_hint": "daily"
  },
  "cached_at": "2026-08-18T09:40:02Z",
  "window": {
    "start": "2026-08-12",
    "end": "2026-08-18",
    "group_by": "day"
  },
  "compared_to": {
    "start": "2026-06-19",
    "end": "2026-07-18"
  },
  "rate": {
    "gmail_postmaster_spam_rate_percent": 0.11,
    "delta_pts": 0.03,
    "peak": {
      "date": "2026-08-02",
      "value_percent": 0.34
    },
    "status": "ok"
  },
  "series": {
    "items": [
      {
        "date": "2026-07-19",
        "gmail_postmaster_spam_rate_percent": 0.08
      }
    ],
    "status": "ok"
  }
}

Returns how often the domain's mail is reported as spam by Gmail recipients, as Google Postmaster measures it: the rate for the period and a time series for charting.

This is Google's number for Gmail-received mail only. The feedback-loop complaint rate across all providers is a Bird-measured figure served by the email statistics endpoints; the two count different mail and are rendered as separate lines, never combined. For a domain without a completed Google Postmaster connection, sections report not_configured with a setup path, not an error.

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

Abfrageparameter

sending_domainstring

The sending domain to report on: one of the workspace's verified sending domains, exactly as it appears there. A domain that is not verified in this workspace answers not-found.

fromstring

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.

tostring

Last UTC day of the period, inclusive, in YYYY-MM-DD. Defaults to today.

group_bystring

Bucket size for the series. Defaults to day.

Possible values: day, week, month

comparestring

Include the prior equal-length period, populating compared_to and the rate's delta.

Possible values: previous_period

Antwort-Payload

resource
string
erforderlich

Which resource this response is, echoed for self-description.

domain
string
erforderlich

The sending domain the figures describe.

measurement
object

How the figures were measured. Present only where a figure was weighted or drawn from a named set of sources, which today means placement and the industry benchmark. Absent on the reputation resources and on a live lookup, neither of which weights anything.

Untergeordnete Attribute anzeigen
measurement.sources
array of string
erforderlich

Identifiers of the measurement systems that contributed to these figures. The set grows as measurement coverage does, so treat the values as labels rather than a closed list.

measurement.weighting
object

How the figures were weighted. Present on figures weighted against an audience mix, which is placement's method; measurements that weight nothing carry no weighting block.

Untergeordnete Attribute anzeigen
measurement.weighting.weight_set_id
string
erforderlich

The measurement's own identifier for the audience mix, carried through so a client can tell two weightings apart without comparing basis strings. No operation accepts it.

measurement.weighting.source
nullable string
erforderlich

Which audience mix the weighting used. Null when the measurement weighted these figures by a method this API does not model: the enum is closed so that a client can branch on it exhaustively, which means an unfamiliar method has to answer "not one of these" rather than be passed through. basis usually still describes the method in words when that happens.

measurement.weighting.basis
nullable string
erforderlich

The weighting method behind the rates, as the measurement names it. A slug rather than a sentence, so render it as a label and do not expect it to read as English. Null when the measurement did not state one, which pairs with source: both describe the method, so neither can claim to know it when the measurement was silent.

generated_at
string
erforderlich

When these figures were computed. The measurement service's own stamp where it publishes one; on the resources Bird derives from daily rates it has none to publish, and this is when Bird computed them.

freshness
object
erforderlich

How current the figures are. Freshness differs per resource (authentication data can lag a day or more while blocklist lookups are near real time), so any "as of" label binds from this field, never from a fixed string.

Untergeordnete Attribute anzeigen
cached_at
string

Present when the response was served from a short-lived copy rather than fetched for this request: when that copy was fetched.

window
object
erforderlich

The period every figure in the response covers: whole UTC calendar days, inclusive on both ends. The same window convention the email statistics endpoints use, so figures from the two sources describe the same days and can be combined without adjustment.

Untergeordnete Attribute anzeigen
compared_to
object

The prior equal-length period the delta figures compare against. Present only when the request asked for a comparison.

Untergeordnete Attribute anzeigen
rate
object
erforderlich

The rate at which the domain's mail is reported as spam, as Google Postmaster measures it.

Untergeordnete Attribute anzeigen
series
object
erforderlich

The complaint-rate series, at the grain named in window.group_by. Index by date, never by position.

Untergeordnete Attribute anzeigen

Weiter mit der Dokumentation, Anleitungen und Beispielen zu diesem Thema.