---
title: "Get seed tests for a sending domain"
method: GET
path: "/v1/email/inbox-insights/seed-tests"
tags: ["email-inbox-insights"]
---

# Get seed tests for a sending domain

`GET /v1/email/inbox-insights/seed-tests`

## Request

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

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.

## Query parameters

- `sending_domain` string, required
- `from` string, date
- `to` string, date

## Headers

- `X-Workspace-Id` string
- `X-Organization-Id` string

## Response `200`

Seed tests for the requested domain and period.

- EmailInboxInsightsSeedTests: The meta every Inbox Insights resource carries, whatever it measures, so one client adapter serves them all.
  - `resource` string, required: Which resource this response is, echoed for self-description.
  - `domain` string, required: The sending domain the figures describe.
  - `measurement` EmailInboxInsightsMeasurement: How the figures in this response were measured, so a number is self-describing in a screenshot or a bug report.
    - `sources` 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.
    - `weighting` EmailInboxInsightsWeighting: How the placement figures in this response were weighted, so a number is self-describing wherever it is quoted or screenshotted. Placement rates are a weighted average of per-provider rates against an audience mix (the share of recipients expected at each mailbox provider) rather than a share of delivered volume.
      - `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.
      - `source` 'account' | 'global', required: Where the audience mix behind the placement weighting came from: `account` when it was configured for this account, `global` when a general default was used instead.
      - `basis` string, nullable, 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, 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.
  - `freshness` EmailInboxInsightsFreshness, 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.
    - `as_of` string, date, nullable, required: The most recent UTC day the figures include, or null for a live lookup that has no measurement window.
    - `lag_hint` string, nullable, 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.
  - `cached_at` string, date-time: Present when the response was served from a short-lived copy rather than fetched for this request: when that copy was fetched.
  - `window` EmailInboxInsightsWindow, 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.
    - `start` string, date, required: First UTC day of the period, inclusive.
    - `end` string, date, required: Last UTC day of the period, inclusive.
    - `group_by` 'day' | 'week' | 'month': The bucket size a series is grouped by. Day suits the product's charts; wider grains suit long ranges.
  - `compared_to` EmailInboxInsightsComparedTo: The prior equal-length period the delta figures compare against. Present only when the request asked for a comparison.
    - `start` string, date, required: First UTC day of the prior period, inclusive.
    - `end` string, date, required: Last UTC day of the prior period, inclusive.
  - `tests` EmailInboxInsightsSeedTestList, 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.
    - `items` EmailInboxInsightsSeedTestRow[], required: One row per seed test, newest first.
      - `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.
      - `subject` string, nullable, 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.
      - `tested_at` string, date-time, nullable, required: When the tested send went out, or null while the test is still awaiting it.
      - `list_type` string, required: Which pool of seed addresses a test uses. Which pools an account can use depends on what has been provisioned for it, so read the usable set from the seed-test options rather than assuming these are the only values.
      - `engagement_profile` string, required: Which engagement behaviour the seed addresses simulate. `all` mixes engaged and dormant seeds, which is what makes an engagement split measurable; single-cohort profiles exist too, and the usable set comes from the seed-test options rather than from this list.
      - `seed_count` integer, nullable, required: How many seed addresses the test used.
      - `inbox_rate_percent` number, nullable, required: Share of the test's seed addresses that received the message in the inbox, as a percentage. Null until results arrive.
      - `domain` string, required: The sending domain the test was run for.
      - `regions` string[], nullable, 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.
      - `delta_pts_vs_prior` number, nullable, 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.
    - `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.
    - `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.
  - `latest` EmailInboxInsightsSeedTestDetail: The fields every view of a seed test carries. There is no status field. The measurement reports none for a test it has already run, and nothing else on the surface stands in for one, so a test that is still waiting for its send says so by having no subject and no tested-at date rather than by being labelled.
    - `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.
    - `subject` string, nullable, 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.
    - `tested_at` string, date-time, nullable, required: When the tested send went out, or null while the test is still awaiting it.
    - `list_type` string, required: Which pool of seed addresses a test uses. Which pools an account can use depends on what has been provisioned for it, so read the usable set from the seed-test options rather than assuming these are the only values.
    - `engagement_profile` string, required: Which engagement behaviour the seed addresses simulate. `all` mixes engaged and dormant seeds, which is what makes an engagement split measurable; single-cohort profiles exist too, and the usable set comes from the seed-test options rather than from this list.
    - `seed_count` integer, nullable, required: How many seed addresses the test used.
    - `inbox_rate_percent` number, nullable, required: Share of the test's seed addresses that received the message in the inbox, as a percentage. Null until results arrive.
    - `providers` EmailInboxInsightsSeedTestProviders, required: The per-provider grid for one seed test.
      - `items` EmailInboxInsightsSeedTestProvider[], required: One row per mailbox provider the test placed seeds at.
        - `mailbox_provider` string, required: A mailbox provider, as the measurement identifies it. A lowercase identifier rather than a display name, so pick your own label for it, and treat the set as open: this is a long tail rather than a handful of household names, and some entries are domains (`fastmail.com`, `seznam.cz`) rather than brands. The measurement places mail into its own seed lists, so its buckets are not the ones the [mailbox-provider stats breakdown](/docs/api/reference/get-email-stats-by-mailbox-provider) reports: Microsoft's properties appear here as `hotmail` rather than `microsoft`, and `apple` appears here where the Competitive Insights panel has no measurement for it at all. None of the three is a joinable dimension against the others.
        - `inbox_rate_percent` number, nullable, required: Share of this provider's seeds that received the message in the inbox, as a percentage.
        - `spam_rate_percent` number, nullable, required: Share of this provider's seeds that received the message in spam, as a percentage.
        - `inbox_seeds` integer, required: Seed addresses at this provider that received the message in the inbox.
        - `spam_seeds` integer, required: Seed addresses at this provider that received the message in spam.
        - `total_seeds` integer, required: Seed addresses at this provider included in the test.
        - `gmail_category` EmailInboxInsightsGmailCategory: Which Gmail tab the test's Gmail seeds mostly landed under.
          - `category` string, required: A Gmail tab, as the measurement identifies it. A lowercase identifier rather than a display name, so pick your own label for it, and treat the set as open: these are Gmail's own tabs, and the measurement reports whichever one it saw. `none` is a value rather than an absence: Gmail delivered the mail under no tab at all, which is an ordinary outcome and not a gap in the measurement.
          - `share_percent` number, nullable, required: Share of the test's Gmail seeds that landed under this tab, as a percentage.
      - `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.
    - `auth` EmailInboxInsightsSeedTestAuth, required: How the tested send authenticated, measured on the seed mail itself rather than on reporting from receivers.
      - `spf_pass_rate_percent` number, nullable, required: Share of the test's seed mail that passed SPF, as a percentage.
      - `dkim_pass_rate_percent` number, nullable, required: Share of the test's seed mail that passed DKIM, as a percentage.
      - `dmarc_aligned_rate_percent` number, nullable, required: Share of the test's seed mail that passed DMARC alignment, as a percentage.
      - `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.
    - `engagement_split` EmailInboxInsightsSeedEngagementSplit, 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.
      - `items` EmailInboxInsightsSeedEngagementSplitRow[], required: One row per provider where both cohorts placed seeds.
        - `mailbox_provider` string, required: A mailbox provider, as the measurement identifies it. A lowercase identifier rather than a display name, so pick your own label for it, and treat the set as open: this is a long tail rather than a handful of household names, and some entries are domains (`fastmail.com`, `seznam.cz`) rather than brands. The measurement places mail into its own seed lists, so its buckets are not the ones the [mailbox-provider stats breakdown](/docs/api/reference/get-email-stats-by-mailbox-provider) reports: Microsoft's properties appear here as `hotmail` rather than `microsoft`, and `apple` appears here where the Competitive Insights panel has no measurement for it at all. None of the three is a joinable dimension against the others.
        - `engaged_inbox_rate_percent` number, nullable, required: Inbox rate across seeds simulating engaged recipients, as a percentage.
        - `dormant_inbox_rate_percent` number, nullable, required: Inbox rate across seeds simulating dormant recipients, as a percentage.
        - `gap_pts` number, nullable, 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.
        - `engaged_seeds` integer, required: Seeds simulating engaged recipients at this provider.
        - `dormant_seeds` integer, required: Seeds simulating dormant recipients at this provider.
      - `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.
  - `quota` EmailInboxInsightsSeedTestQuota, 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.
    - `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.
    - `limit` integer, nullable, required: Seed tests included in the billing period, or null when no cap applies to this organization.
    - `resets_at` string, date-time, required: When the billing-period allowance next resets.

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Insufficient permissions
- `404`: Resource not found
- `412`: Precondition failed
- `422`: The request has invalid field values, violates a business rule, or carries a query parameter the endpoint does not declare. Field validation errors use `type: validation_error` and include the affected fields in `details`. Business-rule errors identify the failed rule in `type`.
- `429`: Rate limit exceeded
- `500`: Internal server error
- `503`: The service is temporarily unavailable. If `Retry-After` is present, wait for that delay before retrying; otherwise, retry with exponential backoff. Reuse the same idempotency key and request when retrying a mutation.

---

[API](https://skmtc.dev/messagebird/apis/bird-api.md) · [All operations](https://skmtc.dev/messagebird/apis/bird-api/llms.txt) · [OpenAPI document](https://skmtc.dev/messagebird/apis/bird-api/revisions/3e2a50466454?raw)