get_analytics
Retrieve WhatsApp analytics such as KPIs, activity patterns, rankings, response times, calls, labels, and countries. Filter by date, chat, label, or community and export chats or contacts.
Instructions
Get WhatsApp analytics data: KPIs, activity patterns, rankings, response times, call stats, labels, emojis, words, countries, and more. Supports section-based drill-down, date range filtering, chat/label/community filters, pagination, and chat/contact exports.
Start with section="overview" (default) for a compact summary, then drill into specific sections.
Sections: overview — High-level summary with top 5 chats (~5KB) kpis — Core + account KPIs + account overview activity — Daily/hourly/weekday/monthly + sent/received + message types rankings — Top chats/groups/DMs/senders (paginated) response_times — Avg/median/fastest/slowest + by-hour + by-chat calls — Call statistics (total/answered/missed/video/voice) labels — Labels (business) or Lists (personal) with chat counts emojis — Top emojis (paginated) words — Top words (paginated) countries — Contact country distribution silences — Longest-inactive chats channels — Newsletter/channel details + subscriber counts communities — Community details + sub-groups conversation_starters — Who starts conversations, night msgs, unanswered streaks — Current/longest streak + last active date gaps — Conversation gaps (>1 day silence periods) organization — Pinned/archived/muted/unread chat lists chat_detail — Full analytics for ONE specific chat (requires chat_id) export_chat — Export chat messages in format (requires chat_id + format) export_contacts — Export contacts in format (requires format) community_growth — Community member count history over time channel_growth — Channel subscriber count history over time
Examples: Overview: {} Rankings: { section: "rankings", chat_type: "group", limit: 5 } Filter by label: { section: "activity", label: "Family" } Chat detail: { section: "chat_detail", chat_id: "120363406792713578@g.us" } Export CSV: { section: "export_chat", chat_id: "...", format: "csv", limit: 100 } Export contacts: { section: "export_contacts", format: "vcf" }
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| label | No | Filter by label/list name or ID | |
| limit | No | Max items for paginated sections (default 20, max 500) | |
| query | No | Search keyword — filter analytics to only messages containing this text. Shows activity patterns for conversations mentioning a topic. | |
| format | No | Export format (required for export_chat/export_contacts) | |
| offset | No | Skip N items for pagination | |
| chat_id | No | Filter to specific chat. Required for chat_detail/export_chat | |
| date_to | No | Custom end date (ISO 8601) — overrides date_range | |
| section | No | Analytics section to retrieve | overview |
| chat_type | No | Filter rankings by chat type | |
| community | No | Filter by community name or ID | |
| date_from | No | Custom start date (ISO 8601) — overrides date_range | |
| date_range | No | Preset date range (default: "30d") | |
| target_session | No | Session ID for multi-account routing | |
| include_transcriptions | No | Include audio transcriptions in exports (default true) |