sms-stats

Get outbound SMS statistics by status

Returns one row per lifecycle status with activity in the requested period, ordered by count descending. The statuses are accepted, sent, delivered, undelivered, failed, rejected, and expired.

Rows use send-time attribution. A delivery confirmed during the period for a message accepted earlier counts against the earlier period. A recent period therefore under-reports delivered while delivery reports are still arriving. With at most seven statuses, this breakdown has no cap, ranking, limit, or trend parameters.

The maximum window is 365 days; requesting a longer range returns 422.

get/v1/sms/stats/statuses

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/sms/stats/statuses
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Query parameters

fromstring date
Example:2026-05-01

Start date (inclusive) in 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 date
Example:2026-05-25

End date (inclusive) in 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
Example:Asia/Kathmandu

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.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

Per-status breakdown for the requested period.

totalinteger required

Number of distinct lifecycle statuses with activity in the period (at most seven). Equal to the number of rows returned, since this breakdown is never capped.

Example response

{
  "period": {
    "from": "2026-05-01",
    "to": "2026-05-25",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "data": [
    {
      "status": "delivered",
      "count": 14720
    }
  ],
  "total": 5
}

Changes

No recorded changes to this operation across all 2 revisions of this API.