Get hourly sending statistics

GET

/v1/email/stats/hourly

const series = await bird.email.stats.hourly({ from: "2026-05-01", to: "2026-05-02" });
for (const row of series.data) console.log(row.bucket, row.delivery.delivered);

stats = client.email.stats.hourly(
    from_="2026-05-25T00:00:00Z",
    to="2026-05-25T23:59:59Z",
)
for point in stats.data:
    print(point.bucket, point.delivery)

series, err := client.Email.Stats.Hourly(context.Background(), bird.EmailStatsHourlyParams{
	From: time.Now().Add(-24 * time.Hour),
	To:   time.Now(),
})
if err != nil {
	log.Fatal(err)
}
fmt.Println(series.Data)

$series = $bird->email->stats->hourly(['from' => '2026-05-01', 'to' => '2026-05-02']);
foreach ($series->getData() ?? [] as $row) {
    echo $row->getBucket(), ' ', $row->getDelivery()?->getDelivered(), "\n";
}

bird email stats hourly

curl -X GET "https://us1.platform.bird.com/v1/email/stats/hourly" \
  -H "Authorization: Bearer $TOKEN"

响应200

{
  "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 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 use event time. For example, 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.

查询参数

fromstring

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.

tostring

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).

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.

响应载荷

period

object

必填

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

显示子属性

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.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

必填

显示子属性

继续查看此主题的文档、指南和示例。

获取实施简报

const series = await bird.email.stats.hourly({ from: "2026-05-01", to: "2026-05-02" });
for (const row of series.data) console.log(row.bucket, row.delivery.delivered);

stats = client.email.stats.hourly(
    from_="2026-05-25T00:00:00Z",
    to="2026-05-25T23:59:59Z",
)
for point in stats.data:
    print(point.bucket, point.delivery)

series, err := client.Email.Stats.Hourly(context.Background(), bird.EmailStatsHourlyParams{
	From: time.Now().Add(-24 * time.Hour),
	To:   time.Now(),
})
if err != nil {
	log.Fatal(err)
}
fmt.Println(series.Data)

$series = $bird->email->stats->hourly(['from' => '2026-05-01', 'to' => '2026-05-02']);
foreach ($series->getData() ?? [] as $row) {
    echo $row->getBucket(), ' ', $row->getDelivery()?->getDelivered(), "\n";
}

bird email stats hourly

curl -X GET "https://us1.platform.bird.com/v1/email/stats/hourly" \
  -H "Authorization: Bearer $TOKEN"

响应200

{
  "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
        }
      }
    }
  ]
}

Get hourly sending statistics

查询参数

响应载荷

相关资源