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);
响应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; their absence means no comparable prior data, never 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.
查询参数
sending_domain
string
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.
from
string
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.
to
string
Last UTC day of the period, inclusive, in YYYY-MM-DD. Defaults to today.
group_by
string
Bucket size for the series. Defaults to day.
Possible values: day, week, month
compare
string
Include the prior equal-length period, populating compared_to and every delta field.
Possible values: previous_period
series_providers
array
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_details
boolean
Include per-IP placement detail for the domain's sending infrastructure. Off by default; only the sending-infrastructure view needs it.
响应载荷
resource
string
必填
Which resource this response is, echoed for self-description.
domain
string
必填
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.
显示子属性
measurement.sources
array of string
必填
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.
显示子属性
measurement.weighting.weight_set_id
string
必填
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
必填
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
必填
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
必填
When the measurement service computed these figures.
freshness
object
必填
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.
显示子属性
freshness.as_of
nullable string
必填
The most recent UTC day the figures include, or null for a live lookup that has no measurement window.
freshness.lag_hint
nullable string
必填
How far behind real time this resource usually runs. A lowercase identifier rather than a display label, so pick your own wording for it, and treat the set as open: the measurement names a hint per resource and can add one without notice.
Null when the measurement reports no hint, which several resources do: show the figures without an age rather than inventing one.
Possible values (may grow over time): daily, nightly, near_real_time
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
必填
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.
显示子属性
window.start
string
必填
First UTC day of the period, inclusive.
window.end
string
必填
Last UTC day of the period, inclusive.
window.group_by
string
The bucket size any series in this response is grouped by. Absent on resources with no series.
Possible values: day, week, month
compared_to
object
The prior equal-length period the delta figures compare against. Present only when the request asked for a comparison.
显示子属性
compared_to.start
string
必填
First UTC day of the prior period, inclusive.
compared_to.end
string
必填
Last UTC day of the prior period, inclusive.
summary
object
必填
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.
显示子属性
summary.inbox_rate_percent
nullable number
必填
Estimated share of measured placements that landed in the inbox, as a percentage.
summary.spam_rate_percent
nullable number
必填
Estimated share of measured placements that landed in spam, as a percentage.
summary.missing_rate_percent
nullable number
必填
Estimated share of measured sends that arrived in neither folder, as a percentage.
summary.raw_counts
nullable object
必填
The measured placements the rates above were computed over, or null when the summary has none: a period with no measured mail reports null here rather than four zeros, because a zero count is a real measurement and would read as "we looked and found nothing" for a domain nothing looked at. Read status alongside it.
显示子属性
summary.raw_counts.inbox
integer
必填
Measured placements observed in the inbox.
summary.raw_counts.spam
integer
必填
Measured placements observed in spam.
summary.raw_counts.missing
integer
必填
Measured sends that arrived in neither folder.
summary.raw_counts.measured
integer
必填
Total measured placements the rates were computed over.
summary.read_rate_percent
nullable number
必填
Estimated share of inbox-placed mail that was read, as a percentage, measured by the panel's dwell time. This is not an open rate; the two count different things and are not interchangeable.
summary.delta_pts
object
How the domain-wide rates moved against the prior period, in percentage points. Present only when the request asked for a comparison and the prior period had data; absence means no comparable prior data, never zero change.
显示子属性
summary.delta_pts.inbox
number
必填
Inbox-rate movement in percentage points; negative means it fell.
summary.delta_pts.spam
number
必填
Spam-rate movement in percentage points.
summary.status
string
必填
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
providers
object
必填
The per-provider placement table.
显示子属性
providers.items
array of object
必填
One row per mailbox provider the measurement observed for this domain in the period.
显示子属性
providers.items.mailbox_provider
string
必填
The provider whose placement this row describes.
providers.items.inbox_rate_percent
nullable number
必填
Share of this provider's measured placements that landed in the inbox, as a percentage.
providers.items.spam_rate_percent
nullable number
必填
Share of this provider's measured placements that landed in spam, as a percentage.
providers.items.raw_counts
object
必填
Raw measured placements behind a set of rates, before any weighting. A measured placement is one message whose mailbox destination the measurement observed.
显示子属性
providers.items.raw_counts.inbox
integer
必填
Measured placements observed in the inbox.
providers.items.raw_counts.spam
integer
必填
Measured placements observed in spam.
providers.items.raw_counts.missing
integer
必填
Measured sends that arrived in neither folder.
providers.items.raw_counts.measured
integer
必填
Total measured placements the rates were computed over.
providers.items.delta_pts
number
Inbox-rate movement against the prior period, in percentage points. Present only when the request asked for a comparison and the prior period had data for this provider; absence is not zero change.
providers.items.read_rate_percent
nullable number
必填
Share of this provider's inbox-placed mail that was read, as a percentage.
providers.status
string
必填
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
series
object
必填
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.
显示子属性
series.items
array of object
必填
One point per bucket with measured placements. With providers named in the request, one point per bucket per provider.
显示子属性
series.items.date
string
必填
First UTC day of the bucket.
series.items.mailbox_provider
nullable string
必填
The provider this point describes, or null on the domain-wide line. Per-provider points appear only when the request named providers.
series.items.inbox_rate_percent
nullable number
必填
Inbox share of the bucket's measured placements, as a percentage.
series.items.spam_rate_percent
nullable number
必填
Spam share of the bucket's measured placements, as a percentage.
series.items.inbox_raw_count
integer
必填
Measured placements observed in the inbox in this bucket.
series.items.spam_raw_count
integer
必填
Measured placements observed in spam in this bucket.
series.status
string
必填
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
gmail_tabs
object
必填
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.
显示子属性
gmail_tabs.categories
array of object
必填
One entry per Gmail tab that received mail.
显示子属性
gmail_tabs.categories.category
string
必填
The tab this row describes.
Possible values (may grow over time): primary, promotions, updates, forums, social, none
gmail_tabs.categories.overall_percent
nullable number
必填
Share of the domain's Gmail-placed mail that landed under this tab, as a percentage.
gmail_tabs.categories.inbox_percent
nullable number
必填
Share of this tab's mail that placed in the inbox, as a percentage.
gmail_tabs.categories.spam_percent
nullable number
必填
Share of this tab's mail that placed in spam, as a percentage.
gmail_tabs.status
string
必填
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
ip_details
object
Per-IP placement detail for the domain's sending infrastructure. Returned only when the request asked for IP detail.
显示子属性
ip_details.items
array of object
必填
One row per sending IP the measurement observed for this domain in the period.
显示子属性
ip_details.items.ip
string
必填
The sending IP address.
ip_details.items.inbox_rate_percent
nullable number
必填
Share of this IP's measured placements that landed in the inbox, as a percentage.
ip_details.items.raw_counts
object
必填
Raw measured placements behind a set of rates, before any weighting. A measured placement is one message whose mailbox destination the measurement observed.
显示子属性
ip_details.items.raw_counts.inbox
integer
必填
Measured placements observed in the inbox.
ip_details.items.raw_counts.spam
integer
必填
Measured placements observed in spam.
ip_details.items.raw_counts.missing
integer
必填
Measured sends that arrived in neither folder.
ip_details.items.raw_counts.measured
integer
必填
Total measured placements the rates were computed over.
ip_details.items.spf_pass_rate_percent
nullable number
必填
Share of this IP's measured mail that passed SPF, as a percentage.
ip_details.items.dkim_pass_rate_percent
nullable number
必填
Share of this IP's measured mail that passed DKIM, as a percentage.
ip_details.status
string
必填
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