Sign inGet Started
Commencer
Guides
Référence API
SDK
CLI
Base de connaissances
Changelog

Get aggregate outbound Apple Messages for Business statistics

GET
/v1/amb/stats/summary
const result = await bird.amb.stats.summary({
  business_account_id: "abz_01krdgeqcxet5s7t44vh8rt9mg",
});
console.log(result);
Réponse200
{
  "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,
      "rejected_pct_change": 0
    }
  }
}

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.

Paramètres de requête

fromstring

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

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

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

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_kindstring

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.

Possible values: text, attachment, rich_link, quick_reply, list_picker, time_picker, form, apple_pay, authenticate, imessage_app, interactive

intentstring

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

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

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

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.

comparestring

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.

Possible values: previous_period

Contenu de la réponse

monthly_active_contacts
integer

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.

period
object
obligatoire

The window the response covers (echoed back from the request), plus data_as_of, the freshness boundary the data is current to.

Afficher les attributs enfants
attribution
string
obligatoire

Always accepted_time for outbound statistics.

Possible values: accepted_time, event_time

counts
object
obligatoire

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.

Afficher les attributs enfants
latency
object
obligatoire

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.

Afficher les attributs enfants
latency.processing
object
obligatoire

Approximate p50, p95, and p99 latency percentiles in milliseconds for one latency family. All three are null when no qualifying event contributed a measurement.

Afficher les attributs enfants
first_response
object

Time from the oldest unanswered inbound message to acceptance of the first outbound reply that claims it. Reported on summaries and breakdowns. Omitted when no qualifying reply contributes a measurement.

Afficher les attributs enfants
comparison
object

The same statistics for the equal-length, inclusive period ending immediately before the requested start, together with computed changes for the message counts and rates listed in delta. Present only when compare=previous_period is requested. Monthly active contacts and latency values are returned for both periods without a computed change.

Afficher les attributs enfants

Ressources associées

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.

Obtenir un guide d'implémentation