How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bird Whatsapp Stats API

WhatsApp analytics, including daily and hourly delivery statistics and a KPI summary.

Bird Whatsapp Stats API is one of 65 APIs that Bird publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include whatsapp-stats. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 13 operations across 13 paths, and defines 42 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 3 base URLs: https://{region}.platform.bird.com, https://platform.bird.com, http://localhost:8080.

13 operations 13 paths 42 schemas 13 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.bird.com
Authentication
HTTP Bearer, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 4

Bird Whatsapp Stats API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). An API key is passed in the cookie as bird_session (CookieAuth). An API key is passed in the header as X-Realtime-Key (RealtimeKey). An API key is passed in the header as X-Realtime-Secret (RealtimeSecret). By default, every request must be authenticated.

  • BearerAuth — Pass the API key as a bearer token in the Authorization header. Keys use the format bk{region}. The prefix identifies the region and selects the API endpoint.…
  • CookieAuth — Session cookie set after signing in to the Bird dashboard. The cookie value is an opaque session token; no session data is stored in the cookie itself.
  • RealtimeKey — The Realtime app key. Together with X-Realtime-Secret, it authenticates a request to the Realtime API in addition to the workspace credential. Both values come…
  • RealtimeSecret — The Realtime app secret paired with X-Realtime-Key. The API returns the secret only when the key is created and does not store it. Create a new key and revoke…

Paths & Operations 13

Across 13 paths, the API surfaces 13 operations — 13 GET. Each is listed below with its method, path, parameters, and response codes.

whatsapp-stats 13

WhatsApp analytics, including daily and hourly delivery statistics and a KPI summary.

GET
/v1/whatsapp/stats/summary
Get aggregate outbound WhatsApp statistics
getWhatsAppStatsSummary 8 params → 200400401403422429500503
GET
/v1/whatsapp/stats/daily
Get daily outbound WhatsApp statistics
getWhatsAppStatsDaily 7 params → 200400401403422429500503
GET
/v1/whatsapp/stats/hourly
Get hourly outbound WhatsApp statistics
getWhatsAppStatsHourly 7 params → 200400401403422429500503
GET
/v1/whatsapp/stats/error-codes
Get outbound WhatsApp statistics by error code
getWhatsAppStatsByErrorCode 4 params → 200400401403422429500503
GET
/v1/whatsapp/stats/templates
Get outbound WhatsApp statistics by template
getWhatsAppStatsByTemplate 4 params → 200400401403422429500503
GET
/v1/whatsapp/stats/template-categories
Get outbound WhatsApp statistics by template category
getWhatsAppStatsByTemplateCategory 4 params → 200400401403422429500503
GET
/v1/whatsapp/stats/tags
Get outbound WhatsApp statistics by tag
getWhatsAppStatsByTag 4 params → 200400401403422429500503
GET
/v1/whatsapp/stats/phone-numbers
Get outbound WhatsApp statistics by phone number
getWhatsAppStatsByPhoneNumber 4 params → 200400401403422429500503
GET
/v1/whatsapp/stats/countries
Get outbound WhatsApp statistics by country
getWhatsAppStatsByCountry 4 params → 200400401403422429500503
GET
/v1/whatsapp/stats/inbound/summary
Get aggregate inbound WhatsApp statistics
getWhatsAppInboundStatsSummary 4 params → 200400401403422429500503
GET
/v1/whatsapp/stats/inbound/daily
Get daily inbound WhatsApp statistics
getWhatsAppInboundStatsDaily 3 params → 200400401403422429500503
GET
/v1/whatsapp/stats/inbound/hourly
Get hourly inbound WhatsApp statistics
getWhatsAppInboundStatsHourly 3 params → 200400401403422429500503
GET
/v1/whatsapp/stats/inbound/phone-numbers
Get inbound WhatsApp statistics by phone number
getWhatsAppInboundStatsByPhoneNumber 4 params → 200400401403422429500503

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are ErrorBody (11 properties), WhatsAppStatsComparisonDelta (9 properties), WhatsAppDeliveryStats (7 properties), NextAction (5 properties). Each schema is shown below with its type and property counts.

WhatsAppTemplateCategoryStatsPoint
object
Lifecycle counts, derived rates, and engagement for a single WhatsApp template category over the requested period.
4 properties 4 required
WhatsAppTemplateID
string
WhatsAppStatsSummary
object
WhatsApp lifecycle counts, rates, engagement, and latency percentiles for the full requested period. Counts aggregate the time buckets. Latency percentiles cov…
5 properties 4 required
WhatsAppInboundStatsResponse
object
Received-message time series. period echoes the range the server computed against; data is one row per bucket in chronological order.
2 properties 2 required
WhatsAppStatsByTagResponse
object
Per-tag breakdown for the requested period, ranked by accepted volume descending and capped at the requested limit (default 50, max 200).
3 properties 3 required
WhatsAppStatsResponse
object
Time-series stats payload. period echoes the range and bucket grain the server computed against; data is one row per bucket in chronological order.
2 properties 2 required
WhatsAppStatsByTemplateResponse
object
Per-template breakdown for the requested period, ranked by accepted volume descending and capped at the requested limit (default 50, max 200).
3 properties 3 required
ErrorDetail
object
2 properties 2 required
WhatsAppEngagementStats
object
WhatsApp engagement counts and the derived read rate for the scope of the containing row (the whole requested period or a breakdown dimension). The read field…
2 properties 2 required
ErrorBody
object
11 properties 6 required
WhatsAppStatsByCountryResponse
object
Per-country breakdown for the requested period, ranked by accepted volume descending and capped at the requested limit (default 50, max 200).
3 properties 3 required
WhatsAppStatsComparison
object
The same statistics for the equal-length, inclusive period ending immediately before the requested start, together with the change between the two periods. Pre…
5 properties 5 required
WhatsAppInboundStatsPoint
object
Received-message count for one time bucket (a calendar day or hour), bucketed by the time each message reached your number.
2 properties 2 required
NextAction
object
5 properties 2 required
WhatsAppErrorCodeStatsPoint
object
Number of failed messages for a single normalized failure reason over the requested period.
2 properties 2 required
WhatsAppTemplateStatsPoint
object
Lifecycle counts, derived rates, engagement and latency for a single WhatsApp template over the requested period.
4 properties 4 required
WhatsAppInboundStatsComparison
object
The received-message count for the equal-length, inclusive period ending immediately before the requested start, together with the change between the two perio…
3 properties 3 required
WhatsAppInboundStatsComparisonDelta
object
The change from the preceding period to the requested one. The receivedpctchange field is a signed relative change, computed as (current - previous) / previous…
1 property 1 required
WhatsAppStatsSummaryPeriod
object
The window the server actually computed against. The summary serves two window grains: calendar days (bounds are YYYY-MM-DD) and hours (bounds are RFC 3339 ins…
3 properties 2 required
CountryCode
string
ISO 3166-1 alpha-2 country code.
StatsGrain
string
The bucket grain of the series, either day or hour.
WhatsAppStatsByTemplateCategoryResponse
object
Per-template-category breakdown for the requested period, ranked by accepted volume descending and capped at the requested limit (default 50, max 200).
3 properties 3 required
WhatsAppLatencyQuantiles
object
Approximate p50, p95, and p99 latency percentiles in milliseconds for one latency family. All three are null when no qualifying event contributed a measurement.
3 properties 3 required
WhatsAppInboundPhoneNumberStatsPoint
object
Received-message count for a single business phone number over the requested period.
2 properties 2 required
WhatsAppStatsSeriesPeriod
object
The window and bucket grain the response covers, echoed from the request, plus the freshness boundary the data is current to.
4 properties 3 required
WhatsAppInboundStatsSummaryResponse
object
Total received messages for the requested period.
3 properties 2 required
WhatsAppEngagementCounts
object
WhatsApp engagement counts for a time bucket, attributed by send time. A message accepted on Monday and read on Tuesday counts in Monday's bucket. Read rates a…
1 property 1 required
WhatsAppStatsPoint
object
WhatsApp lifecycle counts, engagement, and latency percentiles for one time bucket (a calendar day or hour), bucketed by send time. Every count in a bucket des…
4 properties 4 required
WhatsAppLatencyStats
object
Latency percentiles in milliseconds for the requested scope: - processing: From acceptance to WhatsApp handoff. - delivery: From WhatsApp handoff to delivery c…
3 properties
WhatsAppTagStatsPoint
object
Lifecycle counts, derived rates, and engagement for a single tag (name:value) over the requested period.
4 properties 4 required
WhatsAppPhoneNumberStatsPoint
object
Lifecycle counts, rates, and engagement for one business phone number over the requested period, including whether the number is shared.
5 properties 5 required
Error
object
1 property 1 required
WhatsAppStatsByPhoneNumberResponse
object
Per-phone-number breakdown for the requested period, ranked by accepted volume descending and capped at the requested limit (default 50, max 200).
3 properties 3 required
WhatsAppErrorCode
string
Standardized failure reason: - insufficientbalance: The workspace wallet could not fund the send. - pricenotfound: No price was configured for the destination…
WhatsAppInboundStatsByPhoneNumberResponse
object
Per-phone-number breakdown of received messages for the requested period, ranked by volume descending and capped at the requested limit (default 50, max 200).
3 properties 3 required
WhatsAppTemplateCategory
string
Meta's content classification for a template. - authentication: delivers one-time passcodes. - utility: delivers transaction-triggered updates (receipts, order…
WhatsAppStatsComparisonDelta
object
Changes from the previous period. A pctchange value is the signed relative change (current - previous) / previous and is null when the previous count is zero.…
9 properties 9 required
WhatsAppCountryStatsPoint
object
Lifecycle counts, derived rates, engagement and latency for a single destination country over the requested period.
4 properties 4 required
WhatsAppStatsByErrorCodeResponse
object
Per-error-code failure breakdown for the requested period, ranked by failure count descending and capped at the requested limit (default 50, max 200).
3 properties 3 required
StatsComparePeriod
string
Set to previousperiod to also return the same figures for the immediately preceding window of equal length, plus the change between the two, so you can show "+…
WhatsAppDeliveryStats
object
WhatsApp lifecycle counts and rates for the requested period, attributed by send time, so a later delivery stays attributed to the period in which its message…
7 properties 7 required
WhatsAppDeliveryCounts
object
WhatsApp lifecycle counts for a time bucket, attributed by send time. A message accepted on Monday and delivered on Tuesday counts in Monday's bucket. The sibl…
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bird-whatsapp-stats-api-openapi.yml Raw ↑

Other APIs Bird publishes across the network.

Bird Customer Data API
Bird Phone Numbers API
Bird Identity Verification API
Bird Touchpoints API
Bird Accounts API
Bird FAQ API
Bird Intent API
Bird SMS Messaging API
Bird Channels API
Bird Contacts API
Bird Conversations API
Bird Legacy MessageBird API
Where this information came from

This is an independent, third-party profile of Bird Whatsapp Stats API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.