whatsapp-stats

Get hourly outbound WhatsApp statistics

Returns one row of WhatsApp 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. Set timezone for local hours instead of UTC, including zones with sub-hour offsets.

Each row includes its own latency percentiles; delivery, failure, and read rates are whole-window aggregates available from the summary endpoint instead. from and to are optional RFC 3339 instants, defaulting to the trailing 168 hours; each bound rounds down to the hour and remains inclusive. A request may span up to 30 days (720 rows). An excessive or reversed window returns 422.

Set one dimension filter at most; more than one returns 422.

get/v1/whatsapp/stats/hourly

Request

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

Query parameters

fromstring date-time
Example:2026-05-25T00:00:00Z

Start of the window (RFC 3339 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. The window may not exceed 30 days (720 hours). Defaults to 168 hours (7 days) before to when omitted.

tostring date-time
Example:2026-05-25T23:59:59Z

End of the window (RFC 3339 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. The window may not exceed 30 days (720 hours). Defaults to the current hour 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.

templatestring
Example:wat_01krdgeqcxet5s7t44vh8rt9mg

Restricts the statistics to one template, identified by its ID (wat_…) or slug. Mutually exclusive with the other dimension filters (category, phone_number, tag); only one may be set per request. An ID matches the template_id key on a row of the per-template breakdown; a slug is accepted for callers that predate that key and resolves to the same messages.

categorystring

Meta's content classification for a template.

  • authentication: delivers one-time passcodes.
  • utility: delivers transaction-triggered updates (receipts, order status).
  • marketing: carries promotional content.

The category determines the sender number and price. This is an open enum. Accept unrecognized values.

Restrict the statistics to a single template category. Mutually exclusive with the other dimension filters (template, phone_number, tag); only one may be set per request. Matches the category key on a row of the per-category breakdown.

phone_numberstring
Example:+13124495569

Restrict the statistics to a single business sender phone number, in E.164 form. Mutually exclusive with the other dimension filters (template, category, tag); only one may be set per request. Matches the phone_number key on a row of the per-phone-number breakdown.

tagstring
Example:campaign:spring_launch

Restrict the statistics to a single tag. Use name to match any value of a tag, or name:value for a specific pair (for example campaign:spring_launch). Mutually exclusive with the other dimension filters (template, category, phone_number); only one may be set per request. A row of the per-tag breakdown carries the same pair in its single tag key.

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

Hourly aggregate stats for the requested period.

Example response

{
  "period": {
    "from": "2026-05-01",
    "to": "2026-05-25",
    "grain": "day",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "data": [
    {
      "bucket": "2026-05-25",
      "delivery": {
        "accepted": 4820,
        "sent": 4810,
        "delivered": 4720,
        "failed": 25,
        "rejected": 412
      },
      "engagement": {
        "read": 3105
      },
      "latency": {
        "processing": {
          "p50_ms": 610,
          "p95_ms": 2140,
          "p99_ms": 5380
        },
        "delivery": {
          "p50_ms": 1530,
          "p95_ms": 6820,
          "p99_ms": 18400
        },
        "total": {
          "p50_ms": 2180,
          "p95_ms": 9060,
          "p99_ms": 24300
        }
      }
    }
  ]
}

Changes

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