bird amb stats hourly
Usage
Code example
bird amb stats hourly [flags]Description
Returns one row of outbound Apple Messages for Business counts and processing-latency percentiles per hour, gap-filled so a silent hour is a zero row rather than a missing one. Every count in a row is attributed to the hour its message was accepted, regardless of when a later event, such as a send failure, arrived. Use it where the daily grain hides the shape; a window spans at most 720 hours (30 days), and for anything longer use bird amb stats daily.
Examples
Code example
bird amb stats hourlyOptions
| Name | Description |
|---|---|
| --business-id | Restrict the statistics to a single business. Mutually exclusive with the other dimension filters (message_kind, intent, group, category, tag); only one may be set per request. Matches the business_id key on a row of the per-business breakdown. |
| --category | Restrict the statistics to a single message category. Mutually exclusive with the other dimension filters (business_id, message_kind, intent, group, tag); only one may be set per request. Matches the category key on a row of the per-category breakdown. |
| --from | Start of the window (RFC 3339 instant), rounded down to the start of its hour and included. The boundary uses the local hour when timezone is set and the UTC hour otherwise. The window may not exceed 30 days (720 hours). Defaults to 168 hours (7 days) before to when omitted. |
| --group | Restrict the statistics to a single entry-point group. Mutually exclusive with the other dimension filters (business_id, message_kind, intent, category, tag); only one may be set per request. Matches the group key on a row of the per-group breakdown. |
| --intent | Restrict the statistics to a single entry-point intent. Mutually exclusive with the other dimension filters (business_id, message_kind, group, category, tag); only one may be set per request. Matches the intent key on a row of the per-intent breakdown. |
| --message-kind | Restrict the statistics to a single message content kind. Mutually exclusive with the other dimension filters (business_id, intent, group, category, tag); only one may be set per request. Matches the message_kind key on a row of the per-content-kind breakdown. Possible values: text, attachment, rich_link, quick_reply, list_picker, time_picker, form, apple_pay, authenticate, imessage_app, interactive. |
| --response-schema | Print the fields this command returns, then exit |
| --tag | 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 (business_id, message_kind, intent, group, category); only one may be set per request. A row of the per-tag breakdown carries the same pair in its single tag key. |
| --timezone | 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. |
| --to | End of the window (RFC 3339 instant), rounded down to the start of its hour and included. The boundary uses the local hour when timezone is set and the UTC hour otherwise, so both bounds are inclusive. The window may not exceed 30 days (720 hours). Defaults to the current hour when omitted. |
Related
| Name | Description |
|---|---|
| bird amb stats by-business | Get outbound Apple Messages for Business statistics by business |
| bird amb stats by-category | Get outbound Apple Messages for Business statistics by category |
| bird amb stats by-error-code | Get outbound Apple Messages for Business statistics by error code |
| bird amb stats by-group | Get outbound Apple Messages for Business statistics by group |
| bird amb stats by-intent | Get outbound Apple Messages for Business statistics by intent |
| bird amb stats by-message-kind | Get outbound Apple Messages for Business statistics by message kind |
| bird amb stats by-tag | Get outbound Apple Messages for Business statistics by tag |
| bird amb stats daily | Get daily outbound Apple Messages for Business statistics |
| bird amb stats summary | Get aggregate outbound Apple Messages for Business statistics |
Related resources
Continue with the documentation, guides and examples for this topic. Resources are in English.
Understand the conceptShould I use a Bird SDK or call the API directly?Follow the learning pathBuild your first integrationImplementation guideSend your first email
Get an implementation brief