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

Get outbound Apple Messages for Business statistics by error code

GET
/v1/amb/stats/error-codes
const result = await bird.amb.stats.byErrorCode({ limit: 2 });
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",
  "data": [
    {
      "error_code": "bird:business_not_registered",
      "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": 2
}

Returns outbound counts and latency percentiles grouped by failure reason, for the requested period. Rows are ranked by send_failed + rejected descending and capped at the requested limit (default 50, max 200). Only messages carrying a failure reason appear: a bird: code is usually a rejection (never charged, never attempted), an apple: code a send failure; use the summary for the period's full accepted total. 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, when a failed reply claimed an unanswered inbound message. There is no delivery receipt on this channel, so there is no delivered count anywhere in the row. This is a workspace-scoped, single-dimension breakdown; it does not cross error code with any other dimension such as business. 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.

Paramètres de requête

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 error-code rows to return, ranked by send_failed + rejected descending.

Contenu de la réponse

period
object
obligatoire

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

Afficher les attributs enfants
attribution
string
obligatoire

Always accepted_time for outbound statistics.

Possible values: accepted_time, event_time

data
array of object
obligatoire

Error-code rows ranked by send_failed + rejected descending.

Afficher les attributs enfants
data.error_code
string
obligatoire

The failure reason these messages share.

data.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
data.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
data.first_response
object

First-response latency for failed replies that claimed an unanswered inbound message. Omitted when no qualifying reply contributes a measurement.

Afficher les attributs enfants
total
integer
obligatoire

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

Ressources associées

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

Obtenir un guide d'implémentation