Documentation
Sign inGet started
शुरू करें
गाइड
API Reference
SDKs
CLI
Knowledge Base
Changelog

Hourly sending statistics

GET
/v1/email/stats/hourly
bird email stats hourly
Returns one row of aggregate sending statistics per hour for the workspace: UTC hours by default, or your local hours when timezone is set (a timezone with a sub-hour offset gets correctly aligned hours). Useful for inspecting send rate, deliverability, and engagement inside a single day or a recent window; hours with no activity are included with zero counts.
Rows are bucketed by event time, not send time: a click recorded at 14:07 for a message sent at 09:00 lands in the 14:00 row.
A single request may span at most 30 days (720 hourly rows); for longer ranges use the daily endpoint, which has a 365-day window. An hourly window longer than 30 days, or a from after to, returns 422.
Query पैरामीटर
from
string
Start of the window (ISO 8601 instant). Rounded down to the start of its hour (the local hour when timezone is set, otherwise the UTC hour), and that hour is included. When timezone is set, a numeric UTC offset here (for example +05:45) is rejected; use a Z (UTC) instant. Defaults to 7 days before to when omitted.
to
string
End of the window (ISO 8601 instant). Rounded down to the start of its hour (the local hour when timezone is set, otherwise the UTC hour), and that hour is included (both bounds inclusive). When timezone is set, a numeric UTC offset here is rejected; use a Z (UTC) instant. Defaults to the current hour when omitted. Window may not exceed 30 days (720 hours).
timezone
string
IANA timezone identifier (for example Asia/Kathmandu) to report in; defaults to UTC. Day and hour boundaries and the default window when from and to are omitted both follow it, so a calendar-day from or to names a local day. A from or to carrying its own UTC offset is rejected while this is set: pass a calendar day or a Z instant.
category
string
Restrict the statistics to a single category: transactional or marketing. Mutually exclusive with the other dimension filters; only one may be set per request.
sending_domain
string
Restrict the statistics to a single sending domain (the part of the From address after @). Mutually exclusive with the other dimension filters; only one may be set per request.
tag
string
Restrict the statistics to a single tag. Use name to match any value of a tag, or name:value for a specific pair (for example campaign:spring_launch). Mutually exclusive with the other dimension filters; only one may be set per request.
sending_ip
string
Restrict the statistics to a single sending IP. Mutually exclusive with the other dimension filters; only one may be set per request. A sending IP is only assigned once a message reaches delivery, so an IP-filtered result reports delivery-side metrics only: accepted, processed, rejected, complaint, and engagement counts are 0 and the processing latency is null; complaint, open, and click rates read 0 when there were deliveries and null when there were none.
recipient_domain
string
Restrict the statistics to a single recipient mailbox domain (the part of the recipient address after the @, for example gmail.com). Mutually exclusive with the other dimension filters; only one may be set per request.
template
string
Restrict the statistics to a single template, by its ID (emt_…) or its name. Mutually exclusive with the other dimension filters; only one may be set per request.
Response Payload
period
object
आवश्यक
The window and bucket grain the response covers, echoed from the request, plus the freshness boundary the data is current to.
चाइल्ड एट्रिब्यूट दिखाएँ
period.from
string
आवश्यक
Inclusive start of the window. A calendar day (YYYY-MM-DD, in the requested timezone) on the day grain; on the hour grain, an RFC 3339 UTC instant marking the start of the first hour bucket, which falls on a local hour boundary when timezone is set.
period.to
string
आवश्यक
Inclusive end of the window. A calendar day (YYYY-MM-DD, in the requested timezone) on the day grain; on the hour grain, an RFC 3339 UTC instant marking the start of the last hour bucket, which falls on a local hour boundary when timezone is set.
period.grain
string
आवश्यक
The bucket grain of the series, either day or hour.
Possible values: day, hour
period.data_as_of
nullable string
The instant the statistics in this response are current to: events recorded up to roughly this time are reflected, while more recent events may not be yet. Statistics are served from a rolling aggregation that refreshes every few seconds, so a response is near-real-time but not live; use this field to label data freshness rather than assuming the numbers are to-the-second. Null when the freshness boundary is not being reported.
data
array of object
आवश्यक
One row per bucket (day or hour, per the grain) in the period, in chronological order. Buckets with no activity are included with zero counts.
चाइल्ड एट्रिब्यूट दिखाएँ
data.bucket
string
आवश्यक
The day (YYYY-MM-DD, in the requested timezone) or hour this point covers, matching the period's grain. An hour bucket is an RFC 3339 UTC instant marking the start of the hour; it falls on a local hour boundary when timezone is set, which is on the UTC hour only for whole-hour offsets.
data.sends_accepted
integer
आवश्यक
Distinct email messages accepted in this bucket, counted at the message level (one per accepted send regardless of how many recipients it addresses). Every other metric in delivery and engagement is recipient-level or event-level.
data.delivery
object
आवश्यक
चाइल्ड एट्रिब्यूट दिखाएँ
data.delivery.accepted
integer
Distinct recipients accepted for delivery after suppression filtering. Reported on time buckets and the period summary; omitted on breakdown rows, whose rollups do not carry it.
data.delivery.processed
integer
आवश्यक
Distinct recipients whose message was processed and handed off for delivery.
data.delivery.delivered
integer
आवश्यक
Distinct recipients whose message the receiving mail server accepted.
data.delivery.bounced
integer
आवश्यक
Distinct recipients whose delivery failed. Approximately the sum of the five bounces.* sub-counts (hard, soft, admin, block, undetermined); the totals are computed independently so they may differ slightly at the approximation error.
data.delivery.bounces
object
आवश्यक
चाइल्ड एट्रिब्यूट दिखाएँ
data.delivery.bounces.hard
integer
आवश्यक
Distinct recipients with a permanent delivery failure (invalid address or non-existent domain).
data.delivery.bounces.soft
integer
आवश्यक
Distinct recipients with a transient delivery failure (mailbox full or server temporarily unavailable).
data.delivery.bounces.admin
integer
आवश्यक
Distinct recipients bounced by an upstream policy block (relaying denied, blocklisted domain).
data.delivery.bounces.block
integer
आवश्यक
Distinct recipients bounced because the receiving mail server blocked the sending IP for reputation reasons.
data.delivery.bounces.undetermined
integer
आवश्यक
Distinct recipients bounced where the receiving server's response did not allow precise classification.
data.delivery.bounces.hard_rate
nullable number
आवश्यक
Fraction of bounced recipients that hard bounced, computed as hard / bounced. Null when bounced is zero.
data.delivery.bounces.soft_rate
nullable number
आवश्यक
Fraction of bounced recipients that soft bounced, computed as soft / bounced. Null when bounced is zero.
data.delivery.bounces.admin_rate
nullable number
आवश्यक
Fraction of bounced recipients that admin bounced, computed as admin / bounced. Null when bounced is zero.
data.delivery.bounces.block_rate
nullable number
आवश्यक
Fraction of bounced recipients that block bounced, computed as block / bounced. Null when bounced is zero.
data.delivery.bounces.undetermined_rate
nullable number
आवश्यक
Fraction of bounced recipients with undetermined classification, computed as undetermined / bounced. Null when bounced is zero.
data.delivery.complained
integer
आवश्यक
Distinct recipients who reported the message as spam via a feedback loop.
data.delivery.deferred
integer
आवश्यक
Distinct recipients whose delivery the receiving server temporarily delayed and is still being retried.
data.delivery.rejected
integer
आवश्यक
Distinct recipients rejected before any delivery attempt. Includes recipients on the workspace suppression list, transmissions that could not be completed, message-generation failures, and recipients refused by sending policy. The per-recipient rejection_reason field on GET /v1/email/messages/{message_id}/recipients surfaces the specific cause.
data.delivery.oob_bounces
integer
आवश्यक
Out-of-band bounce events: distinct failure notifications received after the receiving server had initially confirmed delivery. Counted as deduplicated events, not unique recipients.
data.delivery.effective_delivered
integer
आवश्यक
Recipients who remain in-inbox in this scope after all bounce signals resolve, computed as delivered - oob_bounces. Use this as the base for engagement-rate denominators. Clamped to 0 when oob_bounces exceeds delivered.
data.delivery.all_bounces
integer
आवश्यक
Total recipients in this scope who did not receive the message, computed as bounced + oob_bounces.
data.delivery.oob_rate
nullable number
आवश्यक
Share of this scope's delivery attempts that resulted in an out-of-band bounce, computed as oob_bounces / (delivered + bounced). Null when there were no attempts.
data.delivery.delivery_rate
nullable number
आवश्यक
Share of this scope's delivery attempts that resulted in a message remaining in-inbox, computed as effective_delivered / (delivered + bounced). Null when there were no attempts.
data.delivery.bounce_rate
nullable number
आवश्यक
Share of this scope's delivery attempts that ultimately failed (inband or out-of-band), computed as all_bounces / (delivered + bounced). Because oob_bounces counts events rather than recipients, all_bounces can exceed the attempt count; the rate is clamped to 1. Null when there were no attempts.
data.delivery.complaint_rate
nullable number
आवश्यक
Spam complaints in this scope relative to effectively delivered recipients, computed as complained / effective_delivered. Complaints are attributed by event time, so a scope can record more of them than it effectively delivered, pushing the rate above 1. Null when effective_delivered is zero.
data.engagement
object
आवश्यक
चाइल्ड एट्रिब्यूट दिखाएँ
data.engagement.opens
integer
आवश्यक
Distinct open events, counting repeat opens from the same recipient and opens auto-fetched by inbox privacy features (such as Apple Mail Privacy Protection and the Gmail image proxy).
data.engagement.opens_non_prefetched
integer
आवश्यक
Distinct open events excluding those auto-fetched by inbox privacy features. Same event-counting semantics as opens (repeat opens from the same recipient count separately), with prefetched opens removed.
data.engagement.unique_opens
integer
आवश्यक
Distinct recipients who opened at least once, including opens auto-fetched by inbox privacy features.
data.engagement.unique_opens_non_prefetched
integer
आवश्यक
Distinct recipients who opened at least once, excluding opens auto-fetched by inbox privacy features. This is the numerator used for open rate, so iOS-heavy audiences (Apple Mail Privacy Protection and similar) do not inflate it.
data.engagement.clicks
integer
आवश्यक
Distinct click events, counting repeat clicks from the same recipient.
data.engagement.unique_clicks
integer
आवश्यक
Distinct recipients who clicked at least once.
data.engagement.unsubscribes
integer
आवश्यक
Distinct unsubscribe events, recorded via the list-unsubscribe header or the footer link.
data.engagement.open_rate
nullable number
आवश्यक
Distinct non-prefetched openers relative to effectively delivered recipients in the same scope, computed as unique_opens_non_prefetched / delivery.effective_delivered; on rows without an effective_delivered field (the mailbox-provider breakdowns) the denominator equals delivery.delivered. The numerator excludes opens auto-fetched by inbox privacy features. Opens are attributed by event time, so engagement earned by earlier deliveries can push the rate above 1. Null when the denominator is zero.
data.engagement.click_rate
nullable number
आवश्यक
Distinct clickers relative to effectively delivered recipients in the same scope, computed as unique_clicks / delivery.effective_delivered (delivery.delivered on rows without an effective_delivered field). Clicks are attributed by event time, so engagement earned by earlier deliveries can push the rate above 1. Null when the denominator is zero.
data.engagement.unsubscribe_rate
nullable number
आवश्यक
Unsubscribe events relative to effectively delivered recipients in the same scope, computed as unsubscribes / delivery.effective_delivered (delivery.delivered on rows without an effective_delivered field). Unsubscribes are attributed by event time, so the rate can exceed 1. Null when the denominator is zero.
data.latency
object
आवश्यक
चाइल्ड एट्रिब्यूट दिखाएँ
data.latency.processing
object
p50, p95, and p99 latency percentiles in milliseconds for one latency family over the bucket. Percentiles are approximate (computed from a high-volume aggregation pipeline). All three are null together when no qualifying event contributed a latency measurement in the bucket.
चाइल्ड एट्रिब्यूट दिखाएँ
data.latency.processing.p50_ms
nullable integer
आवश्यक
Median (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.processing.p95_ms
nullable integer
आवश्यक
95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.processing.p99_ms
nullable integer
आवश्यक
99th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.delivery
object
p50, p95, and p99 latency percentiles in milliseconds for one latency family over the bucket. Percentiles are approximate (computed from a high-volume aggregation pipeline). All three are null together when no qualifying event contributed a latency measurement in the bucket.
चाइल्ड एट्रिब्यूट दिखाएँ
data.latency.delivery.p50_ms
nullable integer
आवश्यक
Median (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.delivery.p95_ms
nullable integer
आवश्यक
95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.delivery.p99_ms
nullable integer
आवश्यक
99th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.total
object
p50, p95, and p99 latency percentiles in milliseconds for one latency family over the bucket. Percentiles are approximate (computed from a high-volume aggregation pipeline). All three are null together when no qualifying event contributed a latency measurement in the bucket.
चाइल्ड एट्रिब्यूट दिखाएँ
data.latency.total.p50_ms
nullable integer
आवश्यक
Median (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.total.p95_ms
nullable integer
आवश्यक
95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.total.p99_ms
nullable integer
आवश्यक
99th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.