The identity and technical contract details declared by the specification.
_ListEnvelope
object
3 properties
3 required
EmailInboxInsightsWeighting
object
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…
3 properties
3 required
ErrorDetail
object
2 properties
2 required
EmailInboxInsightsDomainSort
string
Field used to sort owned domains.
EmailInboxInsightsSpamTrapTypeCount
object
Trap hits of one kind.
2 properties
2 required
EmailInboxInsightsSpamTrapSourceCount
object
Trap hits attributed to one trap network.
2 properties
2 required
EmailInboxInsightsPlacementProvider
object
One mailbox provider's placement for the period. Unlike the domain-wide summary, a single provider's rates are unweighted: there is no audience mix to weight w…
6 properties
5 required
EmailInboxInsightsCompare
string
Set to previousperiod to include the immediately preceding window of equal length in the same response, so deltas need no second request.
EmailInboxInsightsComplaints
How often the domain's mail is reported as spam, as Google Postmaster measures it. This is Google's number for Gmail-received mail only; the feedback-loop comp…
EmailInboxInsightsEnvelope
object
The meta a windowed Inbox Insights resource carries: the common fields plus the period the figures cover and how they were measured.
EmailInboxInsightsMeasurement
object
How the figures in this response were measured, so a number is self-describing in a screenshot or a bug report.
2 properties
1 required
EmailInboxInsightsSpamTrapHits
object
The individual trap hits behind the totals. A sample rather than a guaranteed complete list, and its rows do not count hits: one row is one trap address, carry…
3 properties
3 required
EmailInboxInsightsSpamTraps
Whether the domain's mail is reaching spam traps: addresses that exist only to catch senders mailing lists they should not be mailing. Zero hits is a measured…
EmailInboxInsightsPlacementSeries
object
The placement time series, at the grain named in window.groupby. The series is sparse: buckets with no measured placement are omitted rather than returned as z…
2 properties
2 required
EmailInboxInsightsSpamTrapHit
object
One trap address this domain's mail reached, with enough detail to trace where the address came from. A row can represent several hits on the same trap, so rea…
7 properties
6 required
EmailInboxInsightsAuthPassRate
object
One authentication check's pass rate over the period.
4 properties
3 required
ErrorBody
object
11 properties
6 required
EmailInboxInsightsDomainMonitoringResult
object
What switching on the workspace's main sending domain did. There are four outcomes, because each one leaves the customer somewhere different: one domain is now…
2 properties
2 required
EmailInboxInsightsComplaintSeriesPoint
object
One bucket of the complaint-rate series.
2 properties
2 required
EmailInboxInsightsGmailTabCategory
object
How the domain's Gmail-placed mail split across one Gmail tab.
4 properties
4 required
EmailInboxInsightsAuthSources
object
Every system observed sending as this domain, with how each authenticates. This is the table that shows who else sends under the domain's name.
3 properties
3 required
EmailInboxInsightsPlacementCounts
object
Raw measured placements behind a set of rates, before any weighting. A measured placement is one message whose mailbox destination the measurement observed.
4 properties
4 required
EmailInboxInsightsGmailTab
string
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: the…
EmailInboxInsightsPlacementProviders
object
The per-provider placement table.
2 properties
2 required
EmailInboxInsightsDmarcReadinessReason
string
Why the domain is not yet ready to move its DMARC policy to reject. sourcebelowthreshold means at least one legitimate sender is not authenticating well enough…
EmailInboxInsightsDomainUpdate
object
The Inbox Insights setting to change for a sending domain.
1 property
1 required
EmailInboxInsightsFreshness
object
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…
2 properties
2 required
EmailInboxInsightsSectionStatus
string
Whether a section of the response carries figures, and when it does not, why. ok means the section is populated. nodata means the measurement ran and observed…
EmailInboxInsightsPlacementIpDetails
object
Per-IP placement detail for the domain's sending infrastructure. Returned only when the request asked for IP detail.
2 properties
2 required
EmailInboxInsightsTrapSource
string
The trap network that observed a hit. The set grows as coverage does, so treat the values as labels rather than a closed list.
EmailInboxInsightsWeightingSource
string
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 instea…
EmailInboxInsightsAuthentication
Whether the domain's mail authenticates, and who sends as the domain: SPF and DKIM pass rates, the DMARC standing with its published policy, and the per-source…
EmailInboxInsightsTrapType
string
What kind of spam trap was hit. pristine addresses were never used by a real person and never subscribed to anything, so a hit means the address was harvested…
EmailInboxInsightsGroupBy
string
The bucket size a series is grouped by. Day suits the product's charts; wider grains suit long ranges.
NextAction
object
5 properties
2 required
EmailInboxInsightsDomain
object
One of the workspace's verified sending domains, and whether Inbox Insights is switched on for it.
2 properties
2 required
EmailInboxInsightsComplaintSeries
object
The complaint-rate series, at the grain named in window.groupby. Index by date, never by position.
2 properties
2 required
EmailInboxInsightsWindow
object
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,…
3 properties
2 required
EmailInboxInsightsEnvelopeBase
object
The meta every Inbox Insights resource carries, whatever it measures, so one client adapter serves them all.
6 properties
4 required
EmailInboxInsightsPlacement
Where a sending domain's measured mail landed over the period: the domain-wide summary, the per-provider table, the time series, the Gmail tab split, and optio…
EmailInboxInsightsAuthSource
object
One system observed sending as this domain, with how its mail authenticates.
8 properties
8 required
EmailInboxInsightsGmailTabs
object
Where the domain's Gmail-placed mail landed across Gmail's tabs. The status is notapplicable when the domain had no Gmail placement in the period; hide the sec…
2 properties
2 required
EmailInboxInsightsBlocklistListing
object
One listing of a target on one blocklist.
6 properties
6 required
EmailInboxInsightsDomains
A page of sending domains this workspace can report on, and which of them Inbox Insights is switched on for.
SortOrder
string
Sort direction, ascending or descending.
EmailInboxInsightsDmarc
object
The domain's DMARC standing over the period.
7 properties
6 required
EmailInboxInsightsDomainMonitoringOutcome
string
What switching on the main sending domain did. - enabled: Inbox Insights is now switched on for the domain named alongside this. - alreadyon: at least one doma…
EmailInboxInsightsPlacementDeltaPts
object
How the domain-wide rates moved against the prior period, in percentage points. Present only when the request asked for a comparison and the prior period had d…
2 properties
2 required
EmailInboxInsightsIndustryBenchmark
How senders in a domain's industry place, as a median across the industry's measured senders. The benchmark describes the industry, not the domain, so it carri…
EmailInboxInsightsPlacementSeriesPoint
object
One bucket of the placement series.
6 properties
6 required
EmailInboxInsightsBlocklistTarget
object
One target lookup result, its current status, and the listings seen against it. Read status before islisted. Each target is looked up independently and any one…
6 properties
6 required
EmailInboxInsightsDmarcPolicy
string
The DMARC policy published in the domain's DNS record: what receivers are asked to do with mail that fails DMARC.
EmailInboxInsightsPlacementIpDetail
object
One sending IP's placement and authentication pass rates for the period.
5 properties
5 required
EmailInboxInsightsDmarcVerdict
string
How a sending source's mail authenticates against the domain's DMARC policy. aligned passes with both SPF and DKIM aligned; dkimonly and spfonly pass on one me…
EmailInboxInsightsIndustry
object
The industry a sending domain was classified into.
2 properties
2 required
EmailInboxInsightsBlocklists
Whether the domain's sending infrastructure is on any blocklist, checked when the request is made. This is a live lookup rather than a measurement over a perio…
EmailInboxInsightsComplaintPeak
object
The worst day for complaints in the period.
2 properties
2 required
Error
object
1 property
1 required
EmailInboxInsightsPlacementSummary
object
The domain-wide placement figures for the period. These rates are weighted against the audience mix in measurement.weighting, so they can legitimately differ f…
7 properties
6 required
EmailInboxInsightsComparedTo
object
The prior equal-length period the delta figures compare against. Present only when the request asked for a comparison.
2 properties
2 required
EmailInboxInsightsMailboxProvider
string
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 op…
EmailInboxInsightsComplaintRate
object
The rate at which the domain's mail is reported as spam, as Google Postmaster measures it.
4 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Bird publishes across the network.
