--- title: "Get seed tests for a sending domain" canonical: "https://bird.com/docs/api/reference/get-email-inbox-insights-seed-tests" --- # Get seed tests for a sending domain `GET /v1/email/inbox-insights/seed-tests` Returns the seed tests run for a sending domain over the period, newest first, together with the newest test's full results and the organization's seed-test allowance for the current billing period. A seed test sends to a panel of real mailboxes across many providers and reports exactly where each copy landed, so unlike the placement estimates it is a direct measurement of one send. Seed counts are small by nature, so a single seed moves a rate noticeably. The list is capped at 100 tests rather than paged: `tests.truncated` says whether the period holds more than that, and an earlier period reaches the ones left out. A test counts against the billing-period allowance when it is registered, whether or not its send goes out. Scoped API keys, OAuth and service accounts require organization preview access. ## Code samples **TypeScript** ```ts // 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.seedTests.list({ sending_domain: sendingDomain }); console.log(report); ``` Examples: [TypeScript](/docs/api/reference/get-email-inbox-insights-seed-tests.ts.md) · [Python](/docs/api/reference/get-email-inbox-insights-seed-tests.py.md) · [Go](/docs/api/reference/get-email-inbox-insights-seed-tests.go.md) · [PHP](/docs/api/reference/get-email-inbox-insights-seed-tests.php.md) · [CLI](/docs/api/reference/get-email-inbox-insights-seed-tests.cli.md) · [MCP](/docs/api/reference/get-email-inbox-insights-seed-tests.mcp.md) · [cURL](/docs/api/reference/get-email-inbox-insights-seed-tests.curl.md) ## Example response `200` ```json { "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" }, "tests": { "items": [ { "test_id": "91901", "subject": "Fall Preview, first look", "tested_at": "2026-08-13T09:12:00Z", "list_type": "private", "engagement_profile": "all", "seed_count": 212, "inbox_rate_percent": 89.2, "domain": "mail.acme.com", "regions": [ "North America - US", "Europe - UK" ], "delta_pts_vs_prior": -3.1 } ], "truncated": false, "status": "ok" }, "latest": { "test_id": "91901", "subject": "Fall Preview, first look", "tested_at": "2026-08-13T09:12:00Z", "list_type": "private", "engagement_profile": "all", "seed_count": 212, "inbox_rate_percent": 89.2, "providers": { "items": [ { "mailbox_provider": "gmail", "inbox_rate_percent": 95, "spam_rate_percent": 5, "inbox_seeds": 61, "spam_seeds": 3, "total_seeds": 64, "gmail_category": { "category": "promotions", "share_percent": 61 } } ], "status": "ok" }, "auth": { "spf_pass_rate_percent": 100, "dkim_pass_rate_percent": 100, "dmarc_aligned_rate_percent": 100, "status": "ok" }, "engagement_split": { "items": [ { "mailbox_provider": "gmail", "engaged_inbox_rate_percent": 96, "dormant_inbox_rate_percent": 71, "gap_pts": 25, "engaged_seeds": 32, "dormant_seeds": 32 } ], "status": "ok" } }, "quota": { "used": 112, "limit": 300, "resets_at": "2026-09-01T00:00:00Z" } } ``` ## Query parameters - `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. Defaults to 90 days before `to`, which is the span the history view shows. It may be at most 90 days before `to`, which is also the default, so a request naming neither date is already at the limit. Asking for more answers `422`. To reach older tests, request an earlier period. - `to` (string): Last UTC day of the period, inclusive, in YYYY-MM-DD. Defaults to today. ## Response body - `resource` (string, required): Which resource this response is, echoed for self-description. - `domain` (string, required): 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, required): 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, required): 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, required): 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, required): 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, 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. - `freshness` (object, required): 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, required): The most recent UTC day the figures include, or null for a live lookup that has no measurement window. - `freshness.lag_hint` (nullable string, required) 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, required) 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, required): First UTC day of the period, inclusive. - `window.end` (string, required): 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, required): First UTC day of the prior period, inclusive. - `compared_to.end` (string, required): Last UTC day of the prior period, inclusive. - `tests` (object, required): The domain's seed tests over the period, newest first, up to 100 of them. The list is capped rather than paged, so `truncated` says whether older tests in the period were left out. - `tests.items` (array of object, required): One row per seed test, newest first. - `tests.items.test_id` (string, required): The test's identifier. It is a string and needs to stay one: the values are long enough that any language storing every number as a floating point value will round them, and a rounded identifier matches no test. - `tests.items.subject` (nullable string, required): Subject line of the tested send, or null before the send goes out. With `tested_at`, this is what distinguishes a test that has run from one still waiting for its send. - `tests.items.tested_at` (nullable string, required): When the tested send went out, or null while the test is still awaiting it. - `tests.items.list_type` (nullable string, required): The seed pool the test used, or null on a test that predates the recording of it. - `tests.items.engagement_profile` (nullable string, required): The engagement behaviour the seeds simulated, or null on a test that predates the recording of it. - `tests.items.seed_count` (nullable integer, required): How many seed addresses the test used. - `tests.items.inbox_rate_percent` (nullable number, required): Share of the test's seed addresses that received the message in the inbox, as a percentage. Null until results arrive. - `tests.items.domain` (string, required): The sending domain the test was run for. - `tests.items.regions` (nullable array, required): The regions the test placed seeds in, as the seed-test options name them. Null on a test that predates registration, whose regions were never recorded (the same unknown `list_type` and `engagement_profile` carry), and not an empty list, which would claim a test placed seeds in no region at all. - `tests.items.delta_pts_vs_prior` (nullable number, required): How this test's inbox rate compares with the previous test for the same domain, in percentage points. Null when there is no earlier test to compare against. - `tests.truncated` (boolean, required): True when the period holds more than the 100 tests returned, so the list is the newest of them rather than all of them. Request an earlier period to reach the tests left out. - `tests.status` (string, 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. Possible values: `ok`, `no_data`, `not_configured`, `unavailable`, `not_applicable` - `latest` (object): The newest test in the period with its full results, so the summary panels need no second request. Absent when the period holds no tests. - `latest.test_id` (string, required): The test's identifier. It is a string and needs to stay one: the values are long enough that any language storing every number as a floating point value will round them, and a rounded identifier matches no test. - `latest.subject` (nullable string, required): Subject line of the tested send, or null before the send goes out. With `tested_at`, this is what distinguishes a test that has run from one still waiting for its send. - `latest.tested_at` (nullable string, required): When the tested send went out, or null while the test is still awaiting it. - `latest.list_type` (nullable string, required): The seed pool the test used, or null on a test that predates the recording of it. - `latest.engagement_profile` (nullable string, required): The engagement behaviour the seeds simulated, or null on a test that predates the recording of it. - `latest.seed_count` (nullable integer, required): How many seed addresses the test used. - `latest.inbox_rate_percent` (nullable number, required): Share of the test's seed addresses that received the message in the inbox, as a percentage. Null until results arrive. - `latest.providers` (object, required): The per-provider grid for one seed test. - `latest.providers.items` (array of object, required): One row per mailbox provider the test placed seeds at. - `latest.providers.items.mailbox_provider` (string, required): The provider whose treatment of the test this row describes. - `latest.providers.items.inbox_rate_percent` (nullable number, required): Share of this provider's seeds that received the message in the inbox, as a percentage. - `latest.providers.items.spam_rate_percent` (nullable number, required): Share of this provider's seeds that received the message in spam, as a percentage. - `latest.providers.items.inbox_seeds` (integer, required): Seed addresses at this provider that received the message in the inbox. - `latest.providers.items.spam_seeds` (integer, required): Seed addresses at this provider that received the message in spam. - `latest.providers.items.total_seeds` (integer, required): Seed addresses at this provider included in the test. - `latest.providers.items.gmail_category` (object): Which Gmail tab the seeds landed under. Present only on the Gmail row, since no other provider sorts mail into tabs. - `latest.providers.items.gmail_category.category` (string, required) The tab the test's Gmail seeds mostly landed under. Possible values (may grow over time): `primary`, `promotions`, `updates`, `forums`, `social`, `none` - `latest.providers.items.gmail_category.share_percent` (nullable number, required): Share of the test's Gmail seeds that landed under this tab, as a percentage. - `latest.providers.status` (string, 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. Possible values: `ok`, `no_data`, `not_configured`, `unavailable`, `not_applicable` - `latest.auth` (object, required): How the tested send authenticated, measured on the seed mail itself rather than on reporting from receivers. - `latest.auth.spf_pass_rate_percent` (nullable number, required): Share of the test's seed mail that passed SPF, as a percentage. - `latest.auth.dkim_pass_rate_percent` (nullable number, required): Share of the test's seed mail that passed DKIM, as a percentage. - `latest.auth.dmarc_aligned_rate_percent` (nullable number, required): Share of the test's seed mail that passed DMARC alignment, as a percentage. - `latest.auth.status` (string, 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. Possible values: `ok`, `no_data`, `not_configured`, `unavailable`, `not_applicable` - `latest.engagement_split` (object, required): Engaged against dormant placement, per provider. The status is `not_applicable` for a test run with a single-cohort engagement profile, where there is no second group to compare: hide the comparison rather than showing a zero gap. - `latest.engagement_split.items` (array of object, required): One row per provider where both cohorts placed seeds. - `latest.engagement_split.items.mailbox_provider` (string, required): The provider whose treatment of engaged and dormant seeds this row compares. - `latest.engagement_split.items.engaged_inbox_rate_percent` (nullable number, required): Inbox rate across seeds simulating engaged recipients, as a percentage. - `latest.engagement_split.items.dormant_inbox_rate_percent` (nullable number, required): Inbox rate across seeds simulating dormant recipients, as a percentage. - `latest.engagement_split.items.gap_pts` (nullable number, required): Engaged inbox rate minus dormant inbox rate, in percentage points. The value can be negative, which means dormant seeds placed better, and is reported as measured rather than floored at zero. - `latest.engagement_split.items.engaged_seeds` (integer, required): Seeds simulating engaged recipients at this provider. - `latest.engagement_split.items.dormant_seeds` (integer, required): Seeds simulating dormant recipients at this provider. - `latest.engagement_split.status` (string, 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. Possible values: `ok`, `no_data`, `not_configured`, `unavailable`, `not_applicable` - `quota` (object, required): The organization's seed-test allowance for the current billing period. Registering a test spends one of the allowance whether or not its send goes out, and a test that expires unused does not return it. Uncertain registrations can retain allowance. - `quota.used` (integer, required): Allowance used in the current billing period, including retained uncertain registrations. When `limit` is null, usage is not tracked and this field is zero. - `quota.limit` (nullable integer, required): Seed tests included in the billing period, or null when no cap applies to this organization. - `quota.resets_at` (string, required): When the billing-period allowance next resets. ## Related resources - [Should I use a Bird SDK or call the API directly?](/explained/platform/should-i-use-an-sdk-or-call-the-api-directly) (answer) - [Build your first integration](/learn/paths/integration) (course) - [Send your first email](/docs/get-started/send-your-first-email) (docs) [Get an implementation brief](/learn/workspace?topic=api-basics)