Sign inGet Started

Get daily inbound Apple Messages for Business statistics

GET
/v1/amb/stats/inbound/daily
const result = await bird.amb.stats.inbound.daily();
console.log(result);
响应200
{
  "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",
      "received": 182
    }
  ]
}

Returns one row of inbound Apple Messages for Business counts per calendar day for the workspace, gap-filled so a silent day is a zero row rather than a missing one. Every row is attributed to the day the inbound event occurred, not to any earlier outbound message.

This channel has no delivery receipt and no derived rate; each row carries only the raw received count.

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.

查询参数

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.

响应载荷

period
object
必填

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

显示子属性
attribution
string
必填

Always event_time for inbound statistics.

Possible values: accepted_time, event_time

data
array of object
必填

One row per bucket (day or hour, matching the request) in the period, in chronological order. Buckets with no activity are included with a count of zero, so the series charts continuously without client-side gap handling.

显示子属性
data.bucket
string
必填

The day (YYYY-MM-DD) or hour (RFC 3339, on the hour) this point covers, matching the request's grain.

data.received
integer
必填

Distinct messages received in this bucket.