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

Get daily outbound Apple Messages for Business statistics

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

Returns one row of outbound Apple Messages for Business counts and processing-latency percentiles per calendar day for the workspace, gap-filled so a silent day is a zero row rather than a missing one. Every count in a row is attributed to the day its message was accepted, regardless of when a later event, such as a send failure, arrived.

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 calendar days (YYYY-MM-DD), defaulting to the trailing 30 days. The maximum window is 365 days; a longer range returns 422. Set timezone to report rows by your local calendar day. Historical dates are supported within the maximum window length; the requested dates are not shifted forward.

Set at most one dimension filter (business_account_id, message_kind, intent, group, category, or tag) to restrict the statistics to that dimension's value; setting more than one returns 422.

Paramètres de requête

fromstring

Start date (inclusive), YYYY-MM-DD. Interpreted as a calendar day in timezone (a UTC day when timezone is omitted). The window may not exceed 365 days. Defaults to 30 days before to when omitted.

tostring

End date (inclusive), YYYY-MM-DD. Interpreted as a calendar day in timezone (a UTC day when timezone is omitted). The window may not exceed 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.

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.

Contenu de la réponse

period
object
obligatoire

The window and bucket grain the response covers, echoed from the request, plus the freshness boundary the data is current to.

Afficher les attributs enfants
period.from
string
obligatoire

Inclusive start of the window. A calendar day (YYYY-MM-DD) on the day grain, an RFC 3339 instant on the hour grain. Historical starts are preserved; the maximum request length does not impose a historical cutoff.

period.to
string
obligatoire

Inclusive end of the window. A calendar day (YYYY-MM-DD) on the day grain, an RFC 3339 instant on the hour grain.

period.grain
string
obligatoire

The bucket grain of the series, either day or hour.

Possible values: day, hour

period.data_as_of
nullable string

Latest time reflected in the statistics. More recent events might not be included yet. Null when the freshness boundary is unavailable.

attribution
string
obligatoire

Always accepted_time for outbound statistics.

Possible values: accepted_time, event_time

data
array of object
obligatoire

One row per day or hour in chronological order. Buckets with no activity contain zero counts.

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