NetBird
whatsapp_stats_summary
Aggregate outbound WhatsApp counts for one window: accepted, sent, delivered, failed and rejected, with delivery and failure rates, read engagement, and processing and end-to-end latency percentiles. Restrict it to one dimension with `template`, `category`, `phone_number` or `tag`, one at a time, not combined. Set `compare` to `previous_period` for the deltas against the window immediately before. `from` and `to` are optional and default to the trailing 30 days. Counts are attributed to the time each message was accepted, so a delivery confirmed today counts against the day its message was accepted; `period.data_as_of` is the freshness boundary the rollups have reached.
Remote bird/mcp
Remote (network-hosted)
Other tools also called whatsapp_stats_summary?
See providers with this name
Input Schema
{
"type": "object",
"properties": {
"to": {
"type": "string",
"description": "Inclusive end of the window: a calendar day (YYYY-MM-DD) or an RFC 3339 instant rounded down to the hour. The timezone parameter makes a calendar day local and rounds an instant down to the local hour. Omit timezone to use UTC. When timezone is set, a numeric UTC offset is rejected; use a calendar day or a Z (UTC) instant. This value must use the same form as from. When omitted, it defaults to today for day windows or the current hour for hour windows in that timezone. Day windows may not exceed 365 days; hour windows may not exceed 720 hours (30 days)."
},
"tag": {
"type": "string",
"description": "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."
},
"from": {
"type": "string",
"description": "Inclusive start of the window: a calendar day (YYYY-MM-DD) or an RFC 3339 instant rounded down to the hour. The timezone parameter makes a calendar day local and rounds an instant down to the local hour. Omit timezone to use UTC. When timezone is set, a numeric UTC offset such as +05:45 is rejected; use a calendar day or a Z (UTC) instant. This value must use the same form as to. When omitted, it defaults to 30 days before to for day windows or 168 hours (7 days) before to for hour windows."
},
"compare": {
"type": "string",
"examples": [
"previous_period"
],
"description": "Set to previous_period to also include the same statistics 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. The comparison window carries any dimension filter set on the request, so a filtered comparison compares like with like."
},
"category": {
"type": "string",
"description": "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."
},
"template": {
"type": "string",
"description": "Restrict the statistics to a single template, by slug. Mutually exclusive with the other dimension filters (category, phone_number, tag); only one may be set per request. Matches the template key on a row of the per-template breakdown."
},
"timezone": {
"type": "string",
"description": "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."
},
"phone_number": {
"type": "string",
"description": "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."
}
}
}