amb-stats

Get hourly outbound Apple Messages for Business statistics

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 the daily endpoint.

There is no delivery receipt on this channel, so there is no delivered count or delivery-latency figure in any row. Each row carries its own latency.processing percentiles. Read first_response from the summary or a breakdown endpoint.

from and to are optional RFC 3339 instants, defaulting to the trailing 168 hours; each bound rounds down to the hour and remains inclusive. A request may span up to 30 days (720 rows). An excessive or reversed window returns 422. Set timezone for local hours instead of UTC, including zones with sub-hour offsets; when the timezone's offset is not a whole number of hours, rows are read from finer-grained internal rollups and combined into hour boundaries automatically, with no parameter to select this. Historical dates are supported within the maximum window length; the requested dates are not shifted forward.

Set one dimension filter at most (business_account_id, message_kind, intent, group, category, or tag); more than one returns 422.

get/v1/amb/stats/hourly

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/amb/stats/hourly
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Query parameters

fromstring date-time
Example:2026-05-25T00:00:00Z

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.

tostring date-time
Example:2026-05-25T23:59:59Z

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.

timezonestring
Example:Asia/Kathmandu

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.

business_account_idstring
Example:abz_01krdgeqcxet5s7t44vh8rt9mg

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_account_id key on a row of the per-business breakdown.

message_kind'text' | 'attachment' | 'rich_link' | 'quick_reply' | 'list_picker' | 'time_picker' | 'form' | 'apple_pay' | 'authenticate' | 'imessage_app' | 'interactive'

Derived message classification for filtering and statistics. Send requests use the native content.type families. Create Apple Pay and authentication requests through the conversation payment and authentication operations.

  • text: Text, optionally with a subject.
  • attachment: One or more files, images, audio clips, or videos.
  • rich_link: A link with a preview card.
  • quick_reply: Two to five reply choices.
  • list_picker: A grouped menu of choices.
  • time_picker: Appointment time slots; a reply may contain only a selected label.
  • form: A multi-page form.
  • imessage_app: A custom iMessage app interaction on a compatible device.
  • interactive: An opaque interactive reference whose subtype is unknown.
  • apple_pay: An Apple Pay request created through the conversation payment operations.
  • authenticate: An identity verification request created through the conversation authentication operations.

Restrict the statistics to a single message content kind. Mutually exclusive with the other dimension filters (business_account_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.

intentstring
Example:order_support

Restrict the statistics to a single entry-point intent. Mutually exclusive with the other dimension filters (business_account_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.

groupstring
Example:sales

Restrict the statistics to a single entry-point group. Mutually exclusive with the other dimension filters (business_account_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.

categorystring
Example:order_update

Restrict the statistics to a single message category. Mutually exclusive with the other dimension filters (business_account_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.

tagstring
Example:campaign:spring_launch

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

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

Hourly aggregate stats for the requested period.

attribution'accepted_time' | 'event_time' required

Which timestamp a statistics response buckets its rows and totals by:

  • accepted_time: attributed to when Bird accepted the outbound message for sending. The outbound send statistics use this, so a later event for the same message, such as a send failure, still counts against the day or hour its message was accepted.
  • event_time: attributed to when the event itself occurred. Inbound message statistics, conversation statistics and the staff per-business failure counts use this, since there is no earlier outbound event to anchor them to.

A response never mixes the two axes: every row and total in one payload shares the same attribution.

Example response

{
  "period": {
    "from": "2026-05-01",
    "to": "2026-05-25",
    "grain": "day",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "attribution": "accepted_time",
  "data": [
    {
      "bucket": "2026-05-25",
      "counts": {
        "accepted": 4820,
        "sent": 4790,
        "send_failed": 30,
        "rejected": 4,
        "sent_rate": 0.9938,
        "send_failure_rate": 0.0062
      },
      "latency": {
        "processing": {
          "p50_ms": 610,
          "p95_ms": 2140,
          "p99_ms": 5380
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.