Documentation
Sign inGet started

bird email stats hourly

Usage

Codebeispiel
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 email_stats_daily; for longer ranges use email_stats_daily, for one aggregate row use email_stats_summary.

Examples

Codebeispiel
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 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.
--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.
--templateRestrict 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.
--timezoneIANA timezone identifier (for example Asia/Kathmandu or America/New_York) to report the statistics in. It is the single source of timezone: day and hour boundaries, and the relative window defaults used when from and to are omitted, are computed in this timezone instead of UTC, so a timezone with a sub-hour offset (such as India at +05:30 or Nepal at +05:45) still gets correct local-day and local-hour totals. When it is set, a from or to given as a calendar day names a local day in this timezone, and one given as an instant stays an absolute point in time but is rounded down to its hour and bucketed in this timezone (so the hour boundaries are local, not UTC). To avoid specifying the zone twice, a from or to that carries its own numeric UTC offset (for example +05:45) is rejected when timezone is set; use a calendar day or a Z (UTC) instant instead. Defaults to UTC.
--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-codeBounces by SMTP error code
bird email stats by-broadcastStats by broadcast
bird email stats by-categoryStats by category
bird email stats by-clientEngagement by email client
bird email stats by-complaint-typeComplaints by type
bird email stats by-locationEngagement by location
bird email stats by-mailbox-providerStats by mailbox provider
bird email stats by-mailbox-provider-regionStats by mailbox provider region
bird email stats by-recipient-domainStats by recipient domain
bird email stats by-sending-domainStats by sending domain
bird email stats by-sending-ipStats by sending IP
bird email stats by-tagStats by tag
bird email stats by-templateStats by template
bird email stats dailyDaily sending statistics
bird email stats summaryAggregate stats summary