Sign inGet Started

Get the industry placement benchmark for a sending domain

GET
/v1/email/inbox-insights/benchmarks/industry
// 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.benchmarks.industry({ sending_domain: sendingDomain });
console.log(report);
Respons200
{
  "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",
  "industry": {
    "id": "44",
    "name": "Apparel"
  },
  "median_inbox_rate_percent": 92.1,
  "window_days": 30,
  "cohort_size": 214,
  "status": "ok"
}

Returns how senders in a sending domain's industry place: the median inbox rate across the industry's measured senders, how many senders that median covers, and the industry the domain was classified into.

The benchmark describes the industry rather than the domain, so it carries no comparison of its own. Compare it against the domain's own inbox rate from the placement resource. Its weighting is a general default rather than any one account's audience mix, a deliberate asymmetry with the placement figure it is compared against, and one worth naming wherever the two appear together.

The status is no_data when too few measured senders share the industry for a median to be meaningful, when the domain's industry is not classified, or before the industry figures have been computed. That state is normal for a young cohort rather than an edge case, so handle it from the start.

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

Parameter Kueri

sending_domainstring

The sending domain whose industry to benchmark: 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.

Payload Respons

resource
string
wajib

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

domain
string
wajib

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.

Tampilkan atribut turunan
measurement.sources
array of string
wajib

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.

Tampilkan atribut turunan
generated_at
string
wajib

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
wajib

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.

Tampilkan atribut turunan
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.

industry
nullable object
wajib

The cohort the median describes, or null when the domain is not classified into an industry. This description already names that as a no_data cause and a normal state for a young cohort, so it needs a representation: without one the only way to report an unclassified domain is a cohort with a blank name.

Tampilkan atribut turunan
median_inbox_rate_percent
nullable number
wajib

The industry's median inbox rate, as a percentage.

window_days
integer

How many days the cohort figure covers. Reported rather than assumed because the period is the one the nightly computation produced, not one the caller chose, so a label built from a requested window would be wrong. Absent when the computation does not report it, in which case a label must not name a period at all.

cohort_size
nullable integer
wajib

How many measured senders the median was computed across.

status
string
wajib

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