Sign inGet Started

Get seed tests for a sending domain

GET
/v1/email/inbox-insights/seed-tests
// 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);
Odpowiedź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"
  },
  "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"
  }
}

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.

Parametry zapytania

sending_domainstring

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.

fromstring

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.

tostring

Last UTC day of the period, inclusive, in YYYY-MM-DD. Defaults to today.

Treść odpowiedzi

resource
string
wymagane

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

domain
string
wymagane

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.

Pokaż atrybuty podrzędne
generated_at
string
wymagane

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
wymagane

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.

Pokaż atrybuty podrzędne
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
wymagane

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.

Pokaż atrybuty podrzędne
compared_to
object

The prior equal-length period the delta figures compare against. Present only when the request asked for a comparison.

Pokaż atrybuty podrzędne
tests
object
wymagane

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.

Pokaż atrybuty podrzędne
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.

Pokaż atrybuty podrzędne
quota
object
wymagane

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.

Pokaż atrybuty podrzędne
quota.used
integer
wymagane

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
wymagane

Seed tests included in the billing period, or null when no cap applies to this organization.

quota.resets_at
string
wymagane

When the billing-period allowance next resets.

Przejdź do dokumentacji, przewodników i przykładów dotyczących tego tematu.