Documentation
Sign inGet started

bird email stats hourly

Usage

Code example
bird email stats hourly [flags]

Description

Per-hour email stats series, gap-filled with zero rows, max 720 hours (30 days). Takes the same single-dimension filters as bird email stats daily; for longer ranges use bird email stats daily, for one aggregate row use bird email stats summary.

Examples

Code example
bird email stats hourly

Options

NameDescription
--categoryRestrict the statistics to a single category: transactional or marketing. Mutually exclusive with the other dimension filters; only one may be set per request.
--fromStart 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.
--recipient-domainRestrict 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.
--response-schemaPrint the fields this command returns, then exit
--sending-domainRestrict 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.
--sending-ipRestrict 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 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.
--tagRestrict 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.
--templateRestricts the statistics to one template, identified by its ID (emt_…) or name. This parameter is mutually exclusive with other dimension filters.
--timezoneIANA 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.
--toEnd 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).
NameDescription
bird email stats by-bounce-codeGet bounces by SMTP error code
bird email stats by-broadcastGet statistics by broadcast
bird email stats by-categoryGet statistics by category
bird email stats by-clientGet engagement by email client
bird email stats by-complaint-typeGet complaints by type
bird email stats by-locationGet engagement by location
bird email stats by-mailbox-providerGet statistics by mailbox provider
bird email stats by-mailbox-provider-regionGet statistics by mailbox provider region
bird email stats by-recipient-domainGet statistics by recipient domain
bird email stats by-sending-domainGet statistics by sending domain
bird email stats by-sending-ipGet statistics by sending IP
bird email stats by-tagGet statistics by tag
bird email stats by-templateGet statistics by template
bird email stats dailyGet daily sending statistics
bird email stats summaryGet aggregate email statistics