Get hourly outbound SMS statistics
Returns one row of SMS lifecycle counts per hour. Rows use send-time attribution, so a delivery confirmation is counted in the hour when its message was accepted. Recent rows can under-report delivered while delivery reports arrive.
Rates and latency are whole-window aggregates available from the summary endpoint. Set timezone for local hours instead of UTC, including zones with sub-hour offsets.
A request may span up to 30 days (720 rows). from and to are ISO 8601 instants; each bound rounds down to the hour and remains inclusive. An excessive or reversed window returns 422. Use the daily endpoint for longer ranges.
Request
- Base URL: https://us1.platform.bird.com
- URL: https://us1.platform.bird.com/v1/sms/stats/hourly
- Auth: one of:
- HTTP bearer
- API key in cookie bird_session
Query parameters
Start of the window (ISO 8601 instant), rounded down to the start of its hour and included. The boundary uses the local hour when timezone is set and the UTC hour otherwise. When timezone is set, a numeric UTC offset such as +05:45 is rejected; use a Z (UTC) instant. Defaults to 7 days before to when omitted.
End of the window (ISO 8601 instant), rounded down to the start of its hour and included. The boundary uses the local hour when timezone is set and the UTC hour otherwise, so both bounds are inclusive. When timezone is set, a numeric UTC offset is rejected; use a Z (UTC) instant. Defaults to the current hour when omitted. The window may not exceed 30 days (720 hours).
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.
Restrict the statistics to a single originator (the sender address messages were sent from). Mutually exclusive with the other dimension filters (country, category, carrier); only one may be set per request. Matches the message from.
Restrict the statistics to a single destination country, as an ISO 3166-1 alpha-2 code. Mutually exclusive with the other dimension filters (originator, category, carrier); only one may be set per request.
Restrict the statistics to a single category. Mutually exclusive with the other dimension filters (originator, country, carrier); only one may be set per request.
Restrict the statistics to a single delivery carrier. Mutually exclusive with the other dimension filters (originator, country, category); only one may be set per request.
Headers
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.
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
Hourly aggregate stats for the requested period.
Example response
{
"period": {
"from": "2026-05-01",
"to": "2026-05-31",
"grain": "day",
"data_as_of": "2026-05-25T14:03:10Z"
},
"data": [
{
"bucket": "2026-05-25",
"delivery": {
"accepted": 14820,
"sent": 14810,
"delivered": 14720,
"undelivered": 60,
"failed": 25,
"rejected": 10,
"expired": 5
}
}
]
}Changes
No recorded changes to this operation across all 2 revisions of this API.