whatsapp-stats

Get inbound WhatsApp statistics by phone number

Returns how many WhatsApp messages each of your business phone numbers received. Rows are ranked by volume descending and capped at the requested limit (default 50, max 200), counted by the time each message reached the number.

Each row contains only a count because a received message has one state. Lifecycle and delivery-latency data do not apply to received messages.

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/whatsapp/stats/inbound/phone-numbers

Request

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

Query parameters

fromstring date
Example:2026-06-14

Inclusive start of the window, a calendar day (YYYY-MM-DD). Interpreted in timezone, or UTC when omitted. Must not be after to. Max window 365 days. Defaults to 30 days before to when omitted.

tostring date
Example:2026-07-13

Inclusive end of the window, a calendar day (YYYY-MM-DD). Interpreted in timezone, or UTC when omitted. Max window 365 days. Defaults to today in that timezone when omitted.

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.

limitinteger

Maximum number of phone-number rows to return, ranked by received-message volume descending.

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-phone-number breakdown of received messages for the requested period.

totalinteger required

Total distinct phone numbers with received messages in the period, regardless of limit. When it exceeds the number of rows returned, the ranking was capped; raise limit (up to 200) or narrow the window to see more.

Example response

{
  "period": {
    "from": "2026-05-01",
    "to": "2026-05-25",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "data": [
    {
      "phone_number": "+13124495569",
      "received": 182
    }
  ],
  "total": 2
}

Changes

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