Get seed tests for a sending domain
/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);# Requires Insights preview access for the organization.
sending_domain = None
for domain in client.email.inbox_insights.domains.list(search="mail.example.com"):
if domain.domain == "mail.example.com":
sending_domain = domain.domain
break
if sending_domain is None:
raise ValueError("Verify mail.example.com in this workspace first")
report = client.email.inbox_insights.seed_tests.list(sending_domain=sending_domain)
print(report.model_dump_json())// Requires Insights preview access for the organization.
client, err := bird.NewClient(option.WithAPIKey(os.Getenv("BIRD_API_KEY")))
if err != nil {
log.Fatal(err)
}
ctx := context.Background()
sendingDomain := ""
for domain, err := range client.Email.InboxInsights.Domains.List(ctx, bird.EmailInboxInsightsDomainsListParams{Search: "mail.example.com"}) {
if err != nil {
log.Fatal(err)
}
if domain.Domain != nil && *domain.Domain == "mail.example.com" {
sendingDomain = *domain.Domain
break
}
}
if sendingDomain == "" {
log.Fatal("Verify mail.example.com in this workspace first")
}
report, err := client.Email.InboxInsights.SeedTests.List(ctx, bird.EmailInboxInsightsSeedTestsListParams{SendingDomain: sendingDomain})
if err != nil {
log.Fatal(err)
}
fmt.Println(report)// Requires Insights preview access for the organization.
$sendingDomain = null;
foreach ($bird->email->inboxInsights->domains->list(['search' => 'mail.example.com']) as $domain) {
if ($domain->getDomain() === 'mail.example.com') {
$sendingDomain = $domain->getDomain();
break;
}
}
if ($sendingDomain === null) {
throw new \RuntimeException('Verify mail.example.com in this workspace first');
}
$report = $bird->email->inboxInsights->seedTests->list(['sending_domain' => $sendingDomain]);
var_dump($report);bird email inbox-insights seed-tests list --sending-domain mail.acme.comcurl -X GET "https://us1.platform.bird.com/v1/email/inbox-insights/seed-tests" \
-H "Authorization: Bearer $TOKEN" \
--url-query "sending_domain=mail.acme.com"{
"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.
Query Parameters
sending_domainstringThe 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.
fromstringFirst 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.
tostringLast UTC day of the period, inclusive, in YYYY-MM-DD. Defaults to today.
Response Payload
resourceWhich resource this response is, echoed for self-description.
domainThe sending domain the figures describe.
measurementHow 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.
Show child attributes
measurement.sourcesIdentifiers 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.weightingHow 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.
Show child attributes
measurement.weighting.weight_set_idThe 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.sourceWhich 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.basisThe 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_atWhen 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.
freshnessHow 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.
cached_atPresent when the response was served from a short-lived copy rather than fetched for this request: when that copy was fetched.
windowThe 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.
compared_toThe prior equal-length period the delta figures compare against. Present only when the request asked for a comparison.
testsThe 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.
latestThe newest test in the period with its full results, so the summary panels need no second request. Absent when the period holds no tests.
quotaThe 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.
Related resources
Continue with the documentation, guides and examples for this topic.