sms-stats

Get aggregate inbound SMS statistics

Returns the total number of messages your numbers received over the period, using the time the carrier received each message.

The response contains only a count because a received message has one state. Use the outbound statistics endpoints for delivery rates and latency data about messages you send.

The maximum window is 365 days; a longer range returns 422. Set timezone to resolve the period against your local calendar instead of UTC.

get/v1/sms/stats/inbound/summary

Request

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

Query parameters

fromstring
Example:2026-05-01

Inclusive start of the window, either a calendar day (YYYY-MM-DD) or an RFC 3339 instant rounded down to the hour. The form you use selects the grain the total is resolved at. Interpreted in timezone, or in UTC when timezone is omitted. Must use the same form as to. A numeric UTC offset (for example +05:45) is rejected when timezone is set; pass a calendar day or a Z instant instead. Defaults to 30 days before to for day windows, or 168 hours before to for hour windows.

tostring
Example:2026-05-25

Inclusive end of the window, in the same form as from. Defaults to today, or the current hour for an hour window. A day window may not exceed 365 days and an hour window 720 hours.

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.

compare'previous_period'

Set to previous_period to also return the same figures for the immediately preceding window of equal length, plus the change between the two, so you can show "+X% vs last period" without a second request.

Set to previous_period to include the received-message count for the immediately preceding window of equal length. The response also includes the change between the two, so you can show "+X% vs last period" without a second request.

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

Total received messages for the requested period.

receivedinteger required

Distinct messages received in the period, counted by the time the carrier received them.

Example response

{
  "period": {
    "from": "2026-05-01",
    "to": "2026-05-25",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "received": 4210,
  "comparison": {
    "period": {
      "from": "2026-05-01",
      "to": "2026-05-25",
      "data_as_of": "2026-05-25T14:03:10Z"
    },
    "received": 3980,
    "delta": {
      "received_pct_change": 0.058
    }
  }
}

Changes

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