The identity and technical contract details declared by the specification.
EmailMailboxProviderRegionStatsPoint
object
Delivery, engagement, and deliverability stats for messages grouped by a single mailbox provider and provider region pair over the requested period, for exampl…
6 properties
5 required
EmailSendingIpDeliveryStats
object
Delivery counts and rates for messages attributed to a single sending IP. Per-IP results omit accepted and processed counts. The sending IP becomes known only…
12 properties
12 required
EmailStatsSortMetric
string
Metric to rank breakdown rows by, applied descending. Shared by the breakdowns whose rows have the full delivery, engagement, and latency block: tags, sending…
EmailStatsByMailboxProviderRegionResponse
object
Per-(mailbox provider, provider region) breakdown for the requested period, ranked by the sort metric (default delivered) descending and capped at the requeste…
3 properties
3 required
EmailHealthSignal
object
The current value and verdict for a single sending-health metric over the window.
5 properties
4 required
EmailMailboxProviderSortMetric
string
Metric to rank rows by, applied descending. Shared by every breakdown whose attribution begins at delivery, so processed, rejected, and oobbounces are not part…
EmailLatencyStats
object
Latency percentiles (p50, p95, p99) in milliseconds for the bucket. On the summary endpoint these are computed across the whole period rather than per bucket.…
3 properties
EmailLocationStatsPoint
object
Open and click counts for messages engaged with from a single location over the requested period. Location is resolved from open and click events only, so this…
4 properties
4 required
EmailHealth
object
The workspace's current sending-health verdict over the requested window, plus reference deliverability limits and classification boundaries. Use it to render…
3 properties
3 required
ErrorDetail
object
2 properties
2 required
EmailStatsSeriesPoint
object
One point in a breakdown row's trend series: the headline delivery and engagement rates for that row's dimension value over a single day or hour. Returned only…
8 properties
8 required
ErrorBody
object
11 properties
6 required
EmailStatsByRecipientDomainResponse
object
Per-recipient-domain breakdown for the requested period, ranked by the sort metric (default processed) descending and capped at the requested limit (default 50…
3 properties
3 required
EmailStatsByComplaintTypeResponse
object
Per-complaint-type breakdown for the requested period, ranked by complained descending and capped at the requested limit (default 50, max 200).
3 properties
3 required
EmailStatsSeriesPeriod
object
The window and bucket grain the response covers, echoed from the request, plus the freshness boundary the data is current to.
4 properties
3 required
EmailHealthSignalThresholds
object
The boundaries this signal's status was judged against. Use them to classify your own slices, such as per-domain or per-tag rates, against the same bands. The…
3 properties
3 required
NextAction
object
5 properties
2 required
EmailStatsByLocationResponse
object
Per-location engagement breakdown for the requested period, grouped at the requested groupby granularity, ranked by the sort metric (default uniqueopens) desce…
3 properties
3 required
EmailStatsByCategoryResponse
object
Per-category breakdown for the requested period, ranked by the sort metric (default processed) descending and capped at the requested limit (default 50, max 20…
3 properties
3 required
EmailStatsComparisonDelta
object
The change in each headline metric from the preceding period to the requested one. A pctchange field is a signed relative change in a count, computed as (curre…
11 properties
11 required
EmailStatsBySendingDomainResponse
object
Per-sending-domain breakdown for the requested period, ranked by the sort metric (default processed) descending and capped at the requested limit (default 50,…
3 properties
3 required
StatsGrain
string
The bucket grain of the series, either day or hour.
EmailStatsByBroadcastResponse
object
Per-broadcast breakdown for the requested period, ranked by the sort metric (default processed) descending and capped at the requested limit (default 50, max 2…
3 properties
3 required
EmailSendingDomainStatsPoint
object
Aggregate delivery, engagement, and latency stats for messages sent from a single sending domain over the requested period.
5 properties
4 required
EmailBounceStats
object
Breakdown of bounced by failure type. Each field counts distinct bounced recipients of that type in this row's scope; the five types approximately partition bo…
5 properties
5 required
EmailRecipientDomainStatsPoint
object
Aggregate delivery, engagement, and latency stats for messages sent to a single recipient mailbox domain over the requested period.
5 properties
4 required
EmailStatsByClientResponse
object
Per-client engagement breakdown for the requested period, grouped by the requested groupby facet, ranked by the sort metric (default uniqueopens) descending an…
3 properties
3 required
EmailDeliveryLatencyStats
object
Latency percentiles (p50, p95, p99) in milliseconds for the messages in this breakdown row, for breakdowns whose dimension is known only from delivery onward (…
2 properties
2 required
EmailBounceCodeStatsPoint
object
Bounce counts for a single SMTP status code over the requested period, with the per-type breakdown. This is a deliverability-debugging view keyed on what the r…
3 properties
3 required
EmailStatsByMailboxProviderResponse
object
Per-mailbox-provider breakdown for the requested period, ranked by the sort metric (default delivered) descending and capped at the requested limit (default 50…
3 properties
3 required
EmailBroadcastStatsPoint
object
Delivery, engagement and latency figures for one broadcast's messages over the period you asked for.
4 properties
4 required
EmailStatsByBounceCodeResponse
object
Per-SMTP-code bounce breakdown for the requested period, ranked by the sort metric (default bounced) descending and capped at the requested limit (default 50,…
3 properties
3 required
EmailStatsPoint
object
Aggregate stats for one time bucket (a calendar day or hour, per the requested grain, in the requested timezone or UTC by default), bucketed by event time. Buc…
5 properties
5 required
EmailEngagementSortMetric
string
Metric to rank rows by, applied descending. Shared by the engagement-only breakdowns (locations, email clients), which report open and click counts but no rate…
EmailDeliveryStats
object
Delivery counts and rates for the scope of the containing row (a time bucket, a breakdown dimension, or the whole period). Every count is the number of distinc…
15 properties
14 required
EmailStatsBySendingIpResponse
object
Per-sending-IP breakdown for the requested period, ranked by the sort metric (default delivered) descending and capped at the requested limit (default 50, max…
3 properties
3 required
EmailMailboxProviderStatsPoint
object
Delivery, engagement, and deliverability stats for messages grouped by a single recipient mailbox provider (gmail, microsoft, yahoo, apple, ...) over the reque…
5 properties
4 required
EmailLatencyQuantiles
object
Approximate p50, p95, and p99 latency percentiles in milliseconds for one latency family over the bucket. All three are null when no qualifying event contribut…
3 properties
3 required
EmailSendingIpStatsPoint
object
Delivery and latency stats for messages sent from a single IP address over the requested period. Per-IP attribution begins only after a message is processed: w…
5 properties
3 required
EmailClientStatsPoint
object
Engagement counts for messages opened or clicked from a single email client, operating system, or device type over the requested period. The reading environmen…
4 properties
4 required
EmailEngagementStats
object
Engagement counts and rates for the scope of the containing row (a time bucket, a breakdown dimension, or the whole period). opens, opensnonprefetched and clic…
10 properties
10 required
EmailStatsPeriod
object
The date range this response was actually computed against. Echoed back so clients can render the period without tracking it themselves and so cached responses…
3 properties
2 required
Error
object
1 property
1 required
EmailBounceStatsWithRates
object
Breakdown of bounced by failure type, with each rate as a fraction of bounced. Counts are distinct bounced recipients of that type; the five types approximatel…
10 properties
10 required
EmailStatsByTemplateResponse
object
Per-template breakdown for the requested period, ranked by the sort metric (default processed) descending and capped at the requested limit (default 50, max 20…
3 properties
3 required
StatsTrendGrain
string
Bucket grain for a stats trend series.
EmailEngagementCounts
object
Open and click counts for a breakdown row whose dimension is resolved from engagement events only. opens, opensnonprefetched, and clicks count each event. The…
6 properties
6 required
EmailStatsComparison
object
The same statistics for the equal-length, inclusive period ending the day immediately before the requested start, together with the change between the two peri…
6 properties
6 required
EmailMailboxProviderDeliveryStats
object
Delivery counts and rates for messages attributed to a single recipient mailbox provider. Per-provider results do not include accepted or processed counts, bec…
8 properties
8 required
EmailStatsSummary
object
A single row that aggregates delivery and engagement counts, plus derived rates, across the whole requested period. Use this endpoint for KPI tiles, campaign r…
6 properties
5 required
EmailStatsTagsResponse
object
Per-tag breakdown for the requested period, ranked by the sort metric (default processed) descending and capped at the requested limit (default 50, max 200).
3 properties
3 required
EmailStatsSummaryPeriod
object
The window this response was actually computed against. The summary serves two window grains: calendar days (bounds are YYYY-MM-DD) and hours (bounds are RFC 3…
3 properties
2 required
EmailCategoryStatsPoint
object
Aggregate delivery and engagement stats for a single category over the requested period.
5 properties
4 required
EmailComplaintTypeStatsPoint
object
Complaint counts for a single feedback-loop complaint type over the requested period. A complaint type is recorded only on spam-complaint events, so this break…
2 properties
2 required
EmailStatsResponse
object
Time-series stats payload. period echoes the range and bucket grain actually computed against. data is one row per bucket in chronological order.
2 properties
2 required
EmailTemplateStatsPoint
object
Delivery, engagement, and latency numbers for every message sent with one template over the requested period.
5 properties
4 required
EmailTagStatsPoint
object
Aggregate delivery and engagement stats for a single tag name-and-value pair over the requested period.
5 properties
4 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Bird publishes across the network.
