Sign inGet Started

Get daily sending statistics

GET
/v1/email/stats/daily
const series = await bird.email.stats.daily({ from: "2026-05-01", to: "2026-05-31" });
for (const row of series.data) console.log(row.bucket, row.delivery.delivered);
Risposta200
{
  "period": {
    "from": "2026-05-01",
    "to": "2026-05-31",
    "grain": "day",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "data": [
    {
      "bucket": "2026-05-25",
      "sends_accepted": 412,
      "delivery": {
        "accepted": 14820,
        "processed": 14810,
        "delivered": 14720,
        "bounced": 90,
        "bounces": {
          "hard": 12410,
          "soft": 14290,
          "admin": 410,
          "block": 920,
          "undetermined": 80,
          "hard_rate": 0.454,
          "soft_rate": 0.523,
          "admin_rate": 0.015,
          "block_rate": 0.0337,
          "undetermined_rate": 0.0029
        },
        "complained": 3,
        "deferred": 14,
        "rejected": 10,
        "oob_bounces": 2,
        "effective_delivered": 14718,
        "all_bounces": 92,
        "oob_rate": 0.00014,
        "delivery_rate": 0.9939,
        "bounce_rate": 0.0061,
        "complaint_rate": 0.0002
      },
      "engagement": {
        "opens": 5420,
        "opens_non_prefetched": 3210,
        "unique_opens": 3640,
        "unique_opens_non_prefetched": 2480,
        "clicks": 924,
        "unique_clicks": 621,
        "unsubscribes": 12,
        "open_rate": 0.1683,
        "click_rate": 0.0422,
        "unsubscribe_rate": 0.0009
      },
      "latency": {
        "processing": {
          "p50_ms": 420,
          "p95_ms": 1820,
          "p99_ms": 4920
        },
        "delivery": {
          "p50_ms": 420,
          "p95_ms": 1820,
          "p99_ms": 4920
        },
        "total": {
          "p50_ms": 420,
          "p95_ms": 1820,
          "p99_ms": 4920
        }
      }
    }
  ]
}

Returns one row of aggregate sending statistics per calendar day for the workspace: UTC days by default, or your local days when timezone is set. Days with no activity are included with zero counts, so the series charts without client-side gap handling. Suited to charts and trend lines; for per-message exact accounting use the message detail endpoints.

Rows use event time. For example, a complaint received on Wednesday for a message sent the prior Monday is counted in Wednesday's row.

The maximum window is 365 days; requesting a longer range returns 422.

Parametri di query

fromstring

Start date (inclusive), YYYY-MM-DD. Interpreted as a calendar day in timezone (a UTC day when timezone is omitted). Defaults to 30 days before to when omitted.

tostring

End date (inclusive), YYYY-MM-DD. Interpreted as a calendar day in timezone (a UTC day when timezone is omitted). Defaults to today in that timezone when omitted. Window may not exceed 365 days.

timezonestring

IANA timezone identifier used to group statistics, for example Asia/Kathmandu. The default is UTC. Day and hour boundaries, including the default window when from and to are omitted, follow this timezone. When this parameter is set, pass from and to as calendar days or Z instants instead of timestamps with explicit UTC offsets.

categorystring

Restrict the statistics to a category or a comma-separated union of categories: transactional or marketing. Mutually exclusive with the other dimension filters; only one may be set per request.

sending_domainstring

Restrict the statistics to a sending domain or a comma-separated union of sending domains (the part of the From address after @). Mutually exclusive with the other dimension filters; only one may be set per request.

tagstring

Restrict the statistics to a tag. Use name to match any value of a tag, or name:value for a specific pair (for example campaign:spring_launch). To combine values of one tag name, separate complete pairs with commas, such as campaign:spring,campaign:summer. Different tag names cannot be combined. Mutually exclusive with the other dimension filters; only one may be set per request.

sending_ipstring

Restrict the statistics to a sending IP or a comma-separated union of IPs. Mutually exclusive with the other dimension filters; only one may be set per request. A sending IP is assigned only after a message reaches delivery, so this filter reports delivery-side metrics only. Accepted, processed, rejected, complaint, and engagement counts are 0, and processing latency is null. Complaint, open, and click rates are 0 when deliveries exist and null otherwise.

recipient_domainstring

Restrict the statistics to a recipient mailbox domain or a comma-separated union of domains (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.

templatestring

Restricts the statistics to a template or a comma-separated union of templates, identified by ID (emt_…) or name. This parameter is mutually exclusive with other dimension filters.

Payload di risposta

period
object
obbligatorio

The window and bucket grain the response covers, echoed from the request, plus the freshness boundary the data is current to.

Mostra attributi secondari
data
array of object
obbligatorio

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.

Mostra attributi secondari
data.bucket
string
obbligatorio

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
obbligatorio

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
obbligatorio
Mostra attributi secondari
data.delivery.accepted
integer

Distinct recipients accepted for delivery after suppression filtering. Reported on time buckets and the period summary. Breakdown rows leave it out, because their rollups do not have it.

data.delivery.processed
integer
obbligatorio

Distinct recipients whose message was processed and handed off for delivery.

data.delivery.delivered
integer
obbligatorio

Distinct recipients whose message the receiving mail server accepted.

data.delivery.bounced
integer
obbligatorio

Distinct recipients whose delivery failed. This is approximately the sum of the five bounces.* sub-counts (hard, soft, admin, block, undetermined). The two totals are worked out independently, so they can differ slightly.

data.delivery.bounces
object
obbligatorio
Mostra attributi secondari
data.delivery.complained
integer
obbligatorio

Distinct recipients who reported the message as spam via a feedback loop.

data.delivery.deferred
integer
obbligatorio

Distinct recipients whose delivery the receiving server temporarily delayed and is still being retried.

data.delivery.rejected
integer
obbligatorio

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
obbligatorio

Out-of-band bounce events: distinct failure notifications received after the receiving server had initially confirmed delivery. The count represents deduplicated events rather than unique recipients.

data.delivery.effective_delivered
integer
obbligatorio

Recipients who remain delivered 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
obbligatorio

Total recipients in this scope who did not receive the message, computed as bounced + oob_bounces.

data.delivery.oob_rate
nullable number
obbligatorio

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
obbligatorio

Share of this scope's delivery attempts that remained delivered after all bounce signals, computed as effective_delivered / (delivered + bounced). Null when there were no attempts.

data.delivery.bounce_rate
nullable number
obbligatorio

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
obbligatorio

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
obbligatorio
Mostra attributi secondari
data.latency
object
obbligatorio
Mostra attributi secondari

Continua con la documentazione, le guide e gli esempi per questo argomento.