WhatsApp Message Analytics
Detailed analytics dashboard for WhatsApp messaging, including message volume, delivery status, hourly heatmap, template performance, and top contacts.
Dashboard Data
| METHOD | ROUTE | PERMISSION | DESCRIPTION |
|---|---|---|---|
| GET | /api/v1/WhatsappMessageAnalytics/dashboard |
WhatsappAnalytics:View | Returns the full analytics dashboard payload in one round-trip |
| GET | /api/v1/WhatsappMessageAnalytics/volume |
WhatsappAnalytics:View | Message volume time-series (Inbound vs Outbound per day) |
| GET | /api/v1/WhatsappMessageAnalytics/delivery-status |
WhatsappAnalytics:View | Delivery status bar chart (Delivered + Read per day) |
| GET | /api/v1/WhatsappMessageAnalytics/hourly |
WhatsappAnalytics:View | Hourly activity heatmap (24 buckets, hour 0-23) |
| GET | /api/v1/WhatsappMessageAnalytics/templates |
WhatsappAnalytics:View | Template performance table with delivery % and read % per template |
| GET | /api/v1/WhatsappMessageAnalytics/contacts/top |
WhatsappAnalytics:View | Top N most active contacts by message count |
| GET | /api/v1/WhatsappMessageAnalytics/export |
WhatsappAnalytics:View | Exports a CSV report with one row per message |
| GET | /api/v1/WhatsappMessageAnalytics/tracking-limits |
WhatsappAnalytics:Limit | Retrieves current Meta messaging limits, sent messages, and pending messages |
GET
/api/v1/WhatsappMessageAnalytics/volume
Message volume time-series (Inbound vs Outbound per day).
Query Parameters
| PARAMETER | TYPE | DEFAULT | DESCRIPTION |
|---|---|---|---|
period | enum | Monthly | Daily / Weekly / Monthly / Yearly / Custom |
from | DateTime? | — | Custom range start (used when period=Custom) |
to | DateTime? | — | Custom range end |
GET
/api/v1/WhatsappMessageAnalytics/delivery-status
Delivery status bar chart (Delivered + Read per day).
GET
/api/v1/WhatsappMessageAnalytics/hourly
Hourly activity heatmap (24 buckets, hour 0-23).
GET
/api/v1/WhatsappMessageAnalytics/templates
Template performance table with delivery % and read % per template.
GET
/api/v1/WhatsappMessageAnalytics/contacts/top
Top N most active contacts by message count.
| PARAMETER | TYPE | DEFAULT | DESCRIPTION |
|---|---|---|---|
limit | int | 10 | Number of top contacts to retrieve |
GET
/api/v1/WhatsappMessageAnalytics/export
Exports a CSV report with one row per message.
BASH
curl -X GET "https://api.arthix.ai/api/v1/WhatsappMessageAnalytics/export?period=Monthly" \
-H "X-Api-Key: your_api_key_here" \
-H "X-Firm-Id: your_firm_id" --output report.csvGET
/api/v1/WhatsappMessageAnalytics/tracking-limits
Retrieves the current Meta messaging limits, sent messages, and pending messages for the firm.