Sign inGet Started

Get inbox placement for a sending domain

GET
/v1/email/inbox-insights/placement
// 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.placement({ sending_domain: sendingDomain });
console.log(report);
Odpowiedź200
{
  "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"
  },
  "summary": {
    "inbox_rate_percent": 87.4,
    "spam_rate_percent": 12.6,
    "missing_rate_percent": 0,
    "raw_counts": {
      "inbox": 418211,
      "spam": 60233,
      "missing": 0,
      "measured": 478444
    },
    "read_rate_percent": 21.4,
    "delta_pts": {
      "inbox": -3.1,
      "spam": 3.1
    },
    "status": "ok"
  },
  "providers": {
    "items": [
      {
        "mailbox_provider": "gmail",
        "inbox_rate_percent": 89.2,
        "spam_rate_percent": 10.8,
        "raw_counts": {
          "inbox": 418211,
          "spam": 60233,
          "missing": 0,
          "measured": 478444
        },
        "delta_pts": 0.4,
        "read_rate_percent": 24.3
      }
    ],
    "status": "ok"
  },
  "series": {
    "items": [
      {
        "date": "2026-07-19",
        "mailbox_provider": null,
        "inbox_rate_percent": 90.6,
        "spam_rate_percent": 9.4,
        "inbox_raw_count": 14201,
        "spam_raw_count": 1473
      }
    ],
    "status": "ok"
  },
  "gmail_tabs": {
    "categories": [
      {
        "category": "promotions",
        "overall_percent": 34,
        "inbox_percent": 94,
        "spam_percent": 6
      }
    ],
    "status": "ok"
  },
  "ip_details": {
    "items": [
      {
        "ip": "147.253.40.16",
        "inbox_rate_percent": 89.9,
        "raw_counts": {
          "inbox": 418211,
          "spam": 60233,
          "missing": 0,
          "measured": 478444
        },
        "spf_pass_rate_percent": 99.8,
        "dkim_pass_rate_percent": 99.9
      }
    ],
    "status": "ok"
  }
}

Returns where a sending domain's measured mail landed over the period (inbox or spam): the domain-wide rates, a per-provider table, a time series, the Gmail tab split, and optionally per-IP detail for the domain's sending infrastructure.

Placement figures are estimates from a measurement panel of real mailboxes. Every rate is a percentage of measured placements, never of delivered volume, and the domain-wide summary is weighted against the audience mix described in measurement, so it can legitimately differ from any single provider row. Delta fields appear only when the request asks for a comparison and the prior period has data. Without a requested comparison or comparable prior data they are absent, not zero change.

The series is sparse: buckets with no measured placement are omitted, not returned as zeros, so charts index by date rather than by position. Each section carries its own status, and a successful response never implies every section is populated.

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

Parametry zapytania

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, 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.

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 every delta field.

Possible values: previous_period

series_providersarray

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.

include_ip_detailsboolean

Include per-IP placement detail for the domain's sending infrastructure. Off by default; only the sending-infrastructure view needs it.

Treść odpowiedzi

resource
string
wymagane

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

domain
string
wymagane

The sending domain the figures describe.

measurement
object
wymagane

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.

Pokaż atrybuty podrzędne
generated_at
string
wymagane

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
wymagane

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.

Pokaż atrybuty podrzędne
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
wymagane

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.

Pokaż atrybuty podrzędne
compared_to
object

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

Pokaż atrybuty podrzędne
summary
object
wymagane

The domain-wide placement figures for the period.

These rates are weighted against the audience mix in measurement.weighting, so they can legitimately differ from any single provider row, which has no mix to weight. Rates are percentages of measured placements, never of delivered volume.

Pokaż atrybuty podrzędne
providers
object
wymagane

The per-provider placement table.

Pokaż atrybuty podrzędne
series
object
wymagane

The placement time series, at the grain named in window.group_by.

The series is sparse: buckets with no measured placement are omitted rather than returned as zeros, because an invented zero would be indistinguishable from a measured one. Index by date, never by position.

Pokaż atrybuty podrzędne
gmail_tabs
object
wymagane

Where the domain's Gmail-placed mail landed across Gmail's tabs. The status is not_applicable when the domain had no Gmail placement in the period; hide the section rather than showing an empty split.

Pokaż atrybuty podrzędne
ip_details
object

Per-IP placement detail for the domain's sending infrastructure. Returned only when the request asked for IP detail.

Pokaż atrybuty podrzędne
ip_details.items
array of object
wymagane

One row per sending IP the measurement observed for this domain in the period.

Pokaż atrybuty podrzędne
ip_details.items.ip
string
wymagane

The sending IP address.

ip_details.items.inbox_rate_percent
nullable number
wymagane

Share of this IP's measured placements that landed in the inbox, as a percentage.

ip_details.items.raw_counts
object
wymagane

Raw measured placements behind a set of rates, before any weighting. A measured placement is one message whose mailbox destination the measurement observed.

Pokaż atrybuty podrzędne
ip_details.items.spf_pass_rate_percent
nullable number
wymagane

Share of this IP's measured mail that passed SPF, as a percentage.

ip_details.items.dkim_pass_rate_percent
nullable number
wymagane

Share of this IP's measured mail that passed DKIM, as a percentage.

ip_details.status
string
wymagane

Whether a section of the response carries figures, and when it does not, why.

ok means the section is populated. no_data means the measurement ran and observed nothing to report for this domain in the period. not_configured means the section needs a setup step that has not been completed yet, such as connecting Google Postmaster Tools; treat it as an invitation to finish setup rather than a fault. unavailable means the figures could not be retrieved this time and the same request may well succeed on a retry; the rest of the response is unaffected. not_applicable means the section is meaningless for this domain in this period, so there is nothing to show or fix.

A successful response never implies every section is populated; read each section's status rather than assuming figures are present.

Possible values: ok, no_data, not_configured, unavailable, not_applicable

Przejdź do dokumentacji, przewodników i przykładów dotyczących tego tematu.