amb-stats

Get aggregate outbound Apple Messages for Business statistics

Returns one aggregate row of outbound Apple Messages for Business counts and latency percentiles (p50, p95, and p99) for the requested period. Counts are attributed to the time each message was accepted, so a send failure recorded today counts against the day its message was accepted; period.data_as_of is the freshness boundary the rollups have reached.

There is no delivery receipt on this channel, so there is no delivered count, delivery rate, or delivery-latency figure anywhere in this response. latency.processing covers acceptance to Apple handoff, and first_response measures the oldest unanswered inbound message to acceptance of the first outbound reply that claims it. When no qualifying message contributes a measurement, processing percentiles are null and first_response is omitted.

from and to must both be calendar days or RFC 3339 instants. Day windows cover up to 365 whole days. Instant bounds round down to the hour, remain inclusive, and may span up to 720 hours. Mixing the forms returns 422. Set timezone for local boundaries. 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. Use compare=previous_period to include the preceding equal-length window and computed changes for the message counts and rates listed in comparison.delta. Monthly active contacts and latency values have no computed change.

get/v1/amb/stats/summary

Request

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

Query parameters

fromstring
Example:2026-05-01

Inclusive start of the window: a calendar day (YYYY-MM-DD) or an RFC 3339 instant rounded down to the hour. The timezone parameter makes a calendar day local and rounds an instant down to the local hour. Omit timezone to use UTC. When timezone is set, a numeric UTC offset such as +05:45 is rejected; use a calendar day or a Z (UTC) instant. This value must use the same form as to. When omitted, it defaults to 30 days before to for day windows or 168 hours (7 days) before to for hour windows.

tostring
Example:2026-05-25

Inclusive end of the window: a calendar day (YYYY-MM-DD) or an RFC 3339 instant rounded down to the hour. The timezone parameter makes a calendar day local and rounds an instant down to the local hour. Omit timezone to use UTC. When timezone is set, a numeric UTC offset is rejected; use a calendar day or a Z (UTC) instant. This value must use the same form as from. When omitted, it defaults to today for day windows or the current hour for hour windows in that timezone. Day windows may not exceed 365 days; hour windows may not exceed 720 hours (30 days).

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.

compare'previous_period'

Set to previous_period to also return the same figures for the immediately preceding window of equal length, plus the change between the two, so you can show "+X% vs last period" without a second request.

Set to previous_period to also include the same statistics for the immediately preceding window of equal length, plus the change between the two, so you can show "+X% vs last period" without a second request. The comparison window carries any dimension filter set on the request, so a filtered comparison compares like with like.

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

Aggregate summary for the requested period.

monthly_active_contactsinteger

New monthly active contact charges activated by replies submitted in this window. Each business-scoped contact counts once per UTC calendar month. Omitted for message-kind, intent, group, category or tag filters. Read from retained activation records independently of the message rollup data_as_of boundary; tenant purges remove these records.

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",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "attribution": "accepted_time",
  "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
    }
  },
  "first_response": {
    "p50_ms": 610,
    "p95_ms": 2140,
    "p99_ms": 5380
  },
  "comparison": {
    "period": {
      "from": "2026-05-01",
      "to": "2026-05-25",
      "data_as_of": "2026-05-25T14:03:10Z"
    },
    "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
      }
    },
    "first_response": {
      "p50_ms": 610,
      "p95_ms": 2140,
      "p99_ms": 5380
    },
    "delta": {
      "accepted_pct_change": 0.508,
      "sent_pct_change": 0.501,
      "send_failed_pct_change": -0.12
    }
  }
}

Changes

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