Documentation
Sign inGet started

Aggregate stats summary

GET
/v1/email/stats/summary
bird email stats summary
Returns a single-row aggregate across the requested period covering delivery, bounce, complaint, open, and click counts plus the derived rates, along with processing, delivery, and total latency percentiles (p50/p95/p99). Suitable for KPI tiles, campaign reports, and email digests; the daily and hourly endpoints carry the same metrics per time bucket.
The aggregate is computed against event time (not send time), so engagement received during the period for messages sent earlier is included. Rate fields are null when their denominator is zero.
The window grain follows the form of from and to: calendar days (YYYY-MM-DD, up to 365 days) or RFC 3339 instants (hour grain, up to 720 hours, 30 days), so a rolling window such as the last 24 hours is a single request. Mixing the two forms returns 422. Set timezone to compute day and hour boundaries in a local zone instead of UTC, and compare=previous_period to include the preceding equal-length window in the same response.
Parâmetros de consulta
from
string
Inclusive start of the window: a calendar day (YYYY-MM-DD) or an RFC 3339 instant (rounded down to the hour). Interpreted in timezone (a calendar day names a local day; an instant is rounded down to the local hour), or in UTC when timezone is omitted. A numeric UTC offset (for example +05:45) is rejected when timezone is set; use a calendar day or a Z (UTC) instant. Must use the same form as to. Defaults to 30 days before to for day windows, or 168 hours (7 days) before to for hour windows, when omitted.
to
string
Inclusive end of the window: a calendar day (YYYY-MM-DD) or an RFC 3339 instant (rounded down to the hour). Interpreted in timezone (a calendar day names a local day; an instant is rounded down to the local hour), or in UTC when timezone is omitted. A numeric UTC offset is rejected when timezone is set; use a calendar day or a Z (UTC) instant. Must use the same form as from. Defaults to today for day windows, or the current hour for hour windows, in that timezone, when omitted. Day windows may not exceed 365 days; hour windows may not exceed 720 hours (30 days).
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.
compare
string
Set to previous_period to also include the same statistics for the immediately preceding window of equal length, plus the change between the two, so you can show "+X% vs last period" without a second request.
Possible values: previous_period
Payload de resposta
period
object
obrigatório
The window the response covers (echoed back from the request, day or hour grain), plus data_as_of, the freshness boundary the data is current to.
Mostrar atributos secundários
period.from
string
obrigatório
Inclusive start of the window the response covers. A calendar day (YYYY-MM-DD, in the requested timezone) for day windows; for hour windows, an RFC 3339 UTC instant marking the start of the first hour, which falls on a local hour boundary when timezone is set.
period.to
string
obrigatório
Inclusive end of the window the response covers. A calendar day (YYYY-MM-DD, in the requested timezone) for day windows; for hour windows, an RFC 3339 UTC instant marking the start of the last hour, which falls on a local hour boundary when timezone is set.
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 (for example "as of 14:03") rather than assuming the numbers are to-the-second. Null when the freshness boundary is not being reported.
sends_accepted
integer
obrigatório
Distinct email messages accepted, counted at the message level (one per accepted send regardless of recipient count) and summed per bucket across the period. This counts messages, not recipients, so it is not comparable to delivery.accepted, which counts recipients (a single message to 500 recipients is 1 here and up to 500 there).
delivery
object
obrigatório
Mostrar atributos secundários
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.
delivery.processed
integer
obrigatório
Distinct recipients whose message was processed and handed off for delivery.
delivery.delivered
integer
obrigatório
Distinct recipients whose message the receiving mail server accepted.
delivery.bounced
integer
obrigatório
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.
delivery.bounces
object
obrigatório
Mostrar atributos secundários
delivery.bounces.hard
integer
obrigatório
Distinct recipients with a permanent delivery failure (invalid address or non-existent domain).
delivery.bounces.soft
integer
obrigatório
Distinct recipients with a transient delivery failure (mailbox full or server temporarily unavailable).
delivery.bounces.admin
integer
obrigatório
Distinct recipients bounced by an upstream policy block (relaying denied, blocklisted domain).
delivery.bounces.block
integer
obrigatório
Distinct recipients bounced because the receiving mail server blocked the sending IP for reputation reasons.
delivery.bounces.undetermined
integer
obrigatório
Distinct recipients bounced where the receiving server's response did not allow precise classification.
delivery.bounces.hard_rate
nullable number
obrigatório
Fraction of bounced recipients that hard bounced, computed as hard / bounced. Null when bounced is zero.
delivery.bounces.soft_rate
nullable number
obrigatório
Fraction of bounced recipients that soft bounced, computed as soft / bounced. Null when bounced is zero.
delivery.bounces.admin_rate
nullable number
obrigatório
Fraction of bounced recipients that admin bounced, computed as admin / bounced. Null when bounced is zero.
delivery.bounces.block_rate
nullable number
obrigatório
Fraction of bounced recipients that block bounced, computed as block / bounced. Null when bounced is zero.
delivery.bounces.undetermined_rate
nullable number
obrigatório
Fraction of bounced recipients with undetermined classification, computed as undetermined / bounced. Null when bounced is zero.
delivery.complained
integer
obrigatório
Distinct recipients who reported the message as spam via a feedback loop.
delivery.deferred
integer
obrigatório
Distinct recipients whose delivery the receiving server temporarily delayed and is still being retried.
delivery.rejected
integer
obrigatório
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.
delivery.oob_bounces
integer
obrigatório
Out-of-band bounce events: distinct failure notifications received after the receiving server had initially confirmed delivery. Counted as deduplicated events, not unique recipients.
delivery.effective_delivered
integer
obrigatório
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.
delivery.all_bounces
integer
obrigatório
Total recipients in this scope who did not receive the message, computed as bounced + oob_bounces.
delivery.oob_rate
nullable number
obrigatório
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.
delivery.delivery_rate
nullable number
obrigatório
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.
delivery.bounce_rate
nullable number
obrigatório
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.
delivery.complaint_rate
nullable number
obrigatório
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.
engagement
object
obrigatório
Mostrar atributos secundários
engagement.opens
integer
obrigatório
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).
engagement.opens_non_prefetched
integer
obrigatório
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.
engagement.unique_opens
integer
obrigatório
Distinct recipients who opened at least once, including opens auto-fetched by inbox privacy features.
engagement.unique_opens_non_prefetched
integer
obrigatório
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.
engagement.clicks
integer
obrigatório
Distinct click events, counting repeat clicks from the same recipient.
engagement.unique_clicks
integer
obrigatório
Distinct recipients who clicked at least once.
engagement.unsubscribes
integer
obrigatório
Distinct unsubscribe events, recorded via the list-unsubscribe header or the footer link.
engagement.open_rate
nullable number
obrigatório
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.
engagement.click_rate
nullable number
obrigatório
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.
engagement.unsubscribe_rate
nullable number
obrigatório
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.
latency
object
obrigatório
Mostrar atributos secundários
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.
Mostrar atributos secundários
latency.processing.p50_ms
nullable integer
obrigatório
Median (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.
latency.processing.p95_ms
nullable integer
obrigatório
95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
latency.processing.p99_ms
nullable integer
obrigatório
99th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
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.
Mostrar atributos secundários
latency.delivery.p50_ms
nullable integer
obrigatório
Median (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.
latency.delivery.p95_ms
nullable integer
obrigatório
95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
latency.delivery.p99_ms
nullable integer
obrigatório
99th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
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.
Mostrar atributos secundários
latency.total.p50_ms
nullable integer
obrigatório
Median (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.
latency.total.p95_ms
nullable integer
obrigatório
95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
latency.total.p99_ms
nullable integer
obrigatório
99th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
comparison
object
Mostrar atributos secundários
comparison.period
object
obrigatório
The preceding window these comparison figures cover, the equal-length window ending immediately before the requested start (the prior day for day windows, the prior hour for hour windows). For a request covering 2026-05-01 to 2026-05-31, this is 2026-03-31 to 2026-04-30, both inclusive.
Mostrar atributos secundários
comparison.period.from
string
obrigatório
Inclusive start of the window the response covers. A calendar day (YYYY-MM-DD, in the requested timezone) for day windows; for hour windows, an RFC 3339 UTC instant marking the start of the first hour, which falls on a local hour boundary when timezone is set.
comparison.period.to
string
obrigatório
Inclusive end of the window the response covers. A calendar day (YYYY-MM-DD, in the requested timezone) for day windows; for hour windows, an RFC 3339 UTC instant marking the start of the last hour, which falls on a local hour boundary when timezone is set.
comparison.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 (for example "as of 14:03") rather than assuming the numbers are to-the-second. Null when the freshness boundary is not being reported.
comparison.sends_accepted
integer
obrigatório
Distinct email messages accepted in the preceding period, counted at the message level.
comparison.delivery
object
obrigatório
Mostrar atributos secundários
comparison.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.
comparison.delivery.processed
integer
obrigatório
Distinct recipients whose message was processed and handed off for delivery.
comparison.delivery.delivered
integer
obrigatório
Distinct recipients whose message the receiving mail server accepted.
comparison.delivery.bounced
integer
obrigatório
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.
comparison.delivery.bounces
object
obrigatório
Mostrar atributos secundários
comparison.delivery.bounces.hard
integer
obrigatório
Distinct recipients with a permanent delivery failure (invalid address or non-existent domain).
comparison.delivery.bounces.soft
integer
obrigatório
Distinct recipients with a transient delivery failure (mailbox full or server temporarily unavailable).
comparison.delivery.bounces.admin
integer
obrigatório
Distinct recipients bounced by an upstream policy block (relaying denied, blocklisted domain).
comparison.delivery.bounces.block
integer
obrigatório
Distinct recipients bounced because the receiving mail server blocked the sending IP for reputation reasons.
comparison.delivery.bounces.undetermined
integer
obrigatório
Distinct recipients bounced where the receiving server's response did not allow precise classification.
comparison.delivery.bounces.hard_rate
nullable number
obrigatório
Fraction of bounced recipients that hard bounced, computed as hard / bounced. Null when bounced is zero.
comparison.delivery.bounces.soft_rate
nullable number
obrigatório
Fraction of bounced recipients that soft bounced, computed as soft / bounced. Null when bounced is zero.
comparison.delivery.bounces.admin_rate
nullable number
obrigatório
Fraction of bounced recipients that admin bounced, computed as admin / bounced. Null when bounced is zero.
comparison.delivery.bounces.block_rate
nullable number
obrigatório
Fraction of bounced recipients that block bounced, computed as block / bounced. Null when bounced is zero.
comparison.delivery.bounces.undetermined_rate
nullable number
obrigatório
Fraction of bounced recipients with undetermined classification, computed as undetermined / bounced. Null when bounced is zero.
comparison.delivery.complained
integer
obrigatório
Distinct recipients who reported the message as spam via a feedback loop.
comparison.delivery.deferred
integer
obrigatório
Distinct recipients whose delivery the receiving server temporarily delayed and is still being retried.
comparison.delivery.rejected
integer
obrigatório
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.
comparison.delivery.oob_bounces
integer
obrigatório
Out-of-band bounce events: distinct failure notifications received after the receiving server had initially confirmed delivery. Counted as deduplicated events, not unique recipients.
comparison.delivery.effective_delivered
integer
obrigatório
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.
comparison.delivery.all_bounces
integer
obrigatório
Total recipients in this scope who did not receive the message, computed as bounced + oob_bounces.
comparison.delivery.oob_rate
nullable number
obrigatório
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.
comparison.delivery.delivery_rate
nullable number
obrigatório
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.
comparison.delivery.bounce_rate
nullable number
obrigatório
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.
comparison.delivery.complaint_rate
nullable number
obrigatório
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.
comparison.engagement
object
obrigatório
Mostrar atributos secundários
comparison.engagement.opens
integer
obrigatório
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).
comparison.engagement.opens_non_prefetched
integer
obrigatório
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.
comparison.engagement.unique_opens
integer
obrigatório
Distinct recipients who opened at least once, including opens auto-fetched by inbox privacy features.
comparison.engagement.unique_opens_non_prefetched
integer
obrigatório
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.
comparison.engagement.clicks
integer
obrigatório
Distinct click events, counting repeat clicks from the same recipient.
comparison.engagement.unique_clicks
integer
obrigatório
Distinct recipients who clicked at least once.
comparison.engagement.unsubscribes
integer
obrigatório
Distinct unsubscribe events, recorded via the list-unsubscribe header or the footer link.
comparison.engagement.open_rate
nullable number
obrigatório
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.
comparison.engagement.click_rate
nullable number
obrigatório
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.
comparison.engagement.unsubscribe_rate
nullable number
obrigatório
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.
comparison.latency
object
obrigatório
Mostrar atributos secundários
comparison.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.
Mostrar atributos secundários
comparison.latency.processing.p50_ms
nullable integer
obrigatório
Median (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.
comparison.latency.processing.p95_ms
nullable integer
obrigatório
95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
comparison.latency.processing.p99_ms
nullable integer
obrigatório
99th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
comparison.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.
Mostrar atributos secundários
comparison.latency.delivery.p50_ms
nullable integer
obrigatório
Median (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.
comparison.latency.delivery.p95_ms
nullable integer
obrigatório
95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
comparison.latency.delivery.p99_ms
nullable integer
obrigatório
99th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
comparison.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.
Mostrar atributos secundários
comparison.latency.total.p50_ms
nullable integer
obrigatório
Median (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.
comparison.latency.total.p95_ms
nullable integer
obrigatório
95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
comparison.latency.total.p99_ms
nullable integer
obrigatório
99th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
comparison.delta
object
obrigatório
Mostrar atributos secundários
comparison.delta.sends_accepted_pct_change
nullable number
obrigatório
Relative change in accepted messages (the sends_accepted count) versus the previous period, as a signed fraction. Null when the previous period accepted none.
comparison.delta.delivered_pct_change
nullable number
obrigatório
Relative change in effectively delivered recipients (delivery.effective_delivered, the delivery-rate numerator) versus the previous period, as a signed fraction. Null when the previous period effectively delivered none.
comparison.delta.bounced_pct_change
nullable number
obrigatório
Relative change in total bounces including out-of-band (delivery.all_bounces, the bounce-rate numerator) versus the previous period, as a signed fraction. Null when the previous period had none.
comparison.delta.complained_pct_change
nullable number
obrigatório
Relative change in spam complaints (delivery.complained) versus the previous period, as a signed fraction. Null when the previous period had none.
comparison.delta.opened_pct_change
nullable number
obrigatório
Relative change in unique non-prefetched opens (engagement.unique_opens_non_prefetched, the same count the open rate uses) versus the previous period, as a signed fraction. Null when the previous period had none.
comparison.delta.delivery_rate_pp
nullable number
obrigatório
Signed difference between this period's and the previous period's delivery rate, both fractions in [0,1] (multiply by 100 for percentage points). Null when either period's delivery rate is undefined.
comparison.delta.open_rate_pp
nullable number
obrigatório
Signed difference between this period's and the previous period's open rate, both fractions (multiply by 100 for percentage points). Null when either period's open rate is undefined.
comparison.delta.click_rate_pp
nullable number
obrigatório
Signed difference between this period's and the previous period's click rate, both fractions (multiply by 100 for percentage points). Null when either period's click rate is undefined.
comparison.delta.bounce_rate_pp
nullable number
obrigatório
Signed difference between this period's and the previous period's bounce rate, both fractions in [0,1] (multiply by 100 for percentage points). Null when either period's bounce rate is undefined.
comparison.delta.complaint_rate_pp
nullable number
obrigatório
Signed difference between this period's and the previous period's complaint rate, both fractions (multiply by 100 for percentage points). Null when either period's complaint rate is undefined.
comparison.delta.unsubscribe_rate_pp
nullable number
obrigatório
Signed difference between this period's and the previous period's unsubscribe rate, both fractions (multiply by 100 for percentage points). Null when either period's unsubscribe rate is undefined.