Sign inGet Started
Jetzt starten
Anleitungen
API-Referenz
SDKs
CLI
Wissensdatenbank
Changelog

Get outbound Apple Messages for Business statistics by intent

GET
/v1/amb/stats/intents
const result = await bird.amb.stats.byIntent({ limit: 2 });
console.log(result);
Antwort200
{
  "period": {
    "from": "2026-05-01",
    "to": "2026-05-25",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "attribution": "accepted_time",
  "data": [
    {
      "intent": "order_support",
      "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
      }
    }
  ],
  "total": 5
}

Returns outbound counts and latency percentiles grouped by entry-point intent, for the requested period. Rows are ranked by accepted volume descending and capped at the requested limit (default 50, max 200). Intents are workspace-defined strings configured on the business's entry points and have no fixed vocabulary. Rows use accepted-time attribution: a send failure recorded during the period for a message accepted earlier counts against the earlier period. Each row also carries first_response latency percentiles, omitted when no qualifying message contributes a measurement. There is no delivery receipt on this channel, so there is no delivered count anywhere in the row.

The maximum window is 365 days; a longer range returns 422. Historical dates are supported within the maximum window length; the requested dates are not shifted forward. A breakdown is already a single-dimension view and takes no dimension filter; to restrict statistics to a single intent, use the summary, daily, or hourly statistics instead.

Abfrageparameter

fromstring

Inclusive start of the window, a calendar day (YYYY-MM-DD). Interpreted in timezone, or UTC when omitted. Must not be after to. Max window 365 days. Defaults to 30 days before to when omitted.

tostring

Inclusive end of the window, a calendar day (YYYY-MM-DD). Interpreted in timezone, or UTC when omitted. Max window 365 days. Defaults to today in that timezone when omitted.

timezonestring

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.

limitinteger

Maximum number of intent rows to return, ranked by accepted volume descending.

Antwort-Payload

period
object
erforderlich

The window the response covers (echoed back), plus data_as_of.

Untergeordnete Attribute anzeigen
attribution
string
erforderlich

Always accepted_time for outbound statistics.

Possible values: accepted_time, event_time

data
array of object
erforderlich

Intent rows ranked by accepted volume descending.

Untergeordnete Attribute anzeigen
data.intent
string
erforderlich

The intent these messages were routed under, as configured in the business's entry points. Intents are workspace-defined and have no fixed vocabulary.

data.counts
object
erforderlich

Outbound Apple Messages for Business counts for the requested scope, attributed to when each message was accepted. Apple Messages for Business has no delivery receipt, so there is no delivered count anywhere in this API: sent is the last outbound state Bird observes for a message. Very large counts are close estimates rather than exact tallies. Rates are computed once here, clamped to 1, and null when nothing was accepted.

Untergeordnete Attribute anzeigen
data.counts.accepted
integer
erforderlich

Distinct messages accepted for sending after admission checks. This is the denominator for sent_rate and send_failure_rate.

data.counts.sent
integer
erforderlich

Distinct messages handed off to Apple.

data.counts.send_failed
integer
erforderlich

Distinct accepted messages that Apple refused or that exhausted their send attempts. See last_error.code on the message for the reason; a refused charge is not a send failure, it is rejected.

data.counts.rejected
integer
erforderlich

Distinct messages refused before any send attempt, because the destination has no price, the wallet could not fund the send, or the content cannot be sent yet. Rejected messages are never charged and are not counted in accepted, so the total addressed is accepted + rejected. Excluded from send_failure_rate, which covers send failures only.

data.counts.sent_rate
nullable number
erforderlich

Share of accepted messages Apple acknowledged, computed as sent / accepted. Null when no messages were accepted in scope. This stands where other channels report a delivery rate.

data.counts.send_failure_rate
nullable number
erforderlich

Share of accepted messages that failed to send, computed as send_failed / accepted. Null when no messages were accepted in scope.

data.latency
object
erforderlich

Processing-latency percentiles in milliseconds for the requested scope, from acceptance to Apple handoff. Apple Messages for Business has no delivery receipt, so there is no delivery or total member beside processing. Conversation response timing is reported separately in first_response. Always present; every percentile is null when no qualifying message in scope has a measurement.

Untergeordnete Attribute anzeigen
data.first_response
object

First-response latency percentiles for this intent. Omitted when no qualifying message contributes a measurement.

Untergeordnete Attribute anzeigen
total
integer
erforderlich

Total distinct intents with activity in the period, regardless of limit.

Verwandte Ressourcen

Weiter mit der Dokumentation, Anleitungen und Beispielen zu diesem Thema.

Implementierungs-Briefing erhalten