Sign inGet Started

Get daily inbound SMS statistics

GET
/v1/sms/stats/inbound/daily
const stats = await bird.sms.stats.inbound.daily({ from: "2026-05-01", to: "2026-05-31" });
for (const point of stats.data ?? []) {
  console.log(point.bucket, point.received);
}
响应200
{
  "period": {
    "from": "2026-05-01",
    "to": "2026-05-31",
    "grain": "day",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "data": [
    {
      "bucket": "2026-05-01",
      "received": 128
    }
  ]
}

Returns the number of messages your numbers received, one row per calendar day. Rows use the time the carrier received each message, and days with no messages contain a zero count.

Each row contains only a count because a received message has one state. Use the outbound statistics endpoints for lifecycle and delivery-latency data about messages you send.

The maximum window is 365 days; a longer range returns 422. Set timezone to bucket rows by your local calendar day instead of UTC.

查询参数

fromstring

Start date (inclusive), YYYY-MM-DD. Interpreted as a calendar day in timezone (a UTC day when timezone is omitted). 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). Defaults to today in that timezone when omitted. Window may not exceed 365 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.

响应载荷

period
object
必填

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

显示子属性
data
array of object
必填

One row per bucket (day or hour, per the grain) 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.

显示子属性