email-inbox-insights

Get the industry placement benchmark for a sending domain

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.

get/v1/email/inbox-insights/benchmarks/industry

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/email/inbox-insights/benchmarks/industry
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Query parameters

sending_domainstring required
Example:mail.acme.com

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.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

The industry benchmark for the requested domain's industry.

resourcestring required

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

domainstring required

The sending domain the figures describe.

generated_atstring date-time required

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.

cached_atstring date-time

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

median_inbox_rate_percentnumber nullable required

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

window_daysinteger

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_sizeinteger nullable required

How many measured senders the median was computed across.

status'ok' | 'no_data' | 'not_configured' | 'unavailable' | 'not_applicable' required

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.

Example response

{
  "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"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.