Docs/Dashboard
🔑 API Key required

WhatsApp Message Analytics

Monitor your success in real-time. This analytics dashboard provides clear insights into your message volume, delivery rates, and top-performing templates.

Dashboard Data

METHOD ROUTE PERMISSION DESCRIPTION
GET /api/v1/WhatsappMessageAnalytics/dashboard WhatsappAnalytics:View Instantly load the entire analytics dashboard at once
GET /api/v1/WhatsappMessageAnalytics/volume WhatsappAnalytics:View View a daily breakdown of messages sent versus messages received
GET /api/v1/WhatsappMessageAnalytics/delivery-status WhatsappAnalytics:View Track how many of your messages are successfully delivered and read
GET /api/v1/WhatsappMessageAnalytics/hourly WhatsappAnalytics:View Identify the busiest times of day for your messaging activity
GET /api/v1/WhatsappMessageAnalytics/templates WhatsappAnalytics:View See exactly which templates are performing best with your audience
GET /api/v1/WhatsappMessageAnalytics/contacts/top WhatsappAnalytics:View Identify your most engaged and active contacts
GET /api/v1/WhatsappMessageAnalytics/export WhatsappAnalytics:View Download a detailed CSV report containing the status of every single message
GET /api/v1/WhatsappMessageAnalytics/tracking-limits WhatsappAnalytics:Limit Check your official WhatsApp messaging limits and monitor your sending capacity
GET

/api/v1/WhatsappMessageAnalytics/volume

View a daily breakdown of messages sent versus messages received.

Query Parameters

PARAMETERTYPEDEFAULTDESCRIPTION
periodenumMonthlyDaily / Weekly / Monthly / Yearly / Custom
fromDateTime?—Custom range start (used when period=Custom)
toDateTime?—Custom range end
GET

/api/v1/WhatsappMessageAnalytics/delivery-status

Track how many of your messages are successfully delivered and read.

GET

/api/v1/WhatsappMessageAnalytics/hourly

Identify the busiest times of day for your messaging activity.

GET

/api/v1/WhatsappMessageAnalytics/templates

See exactly which templates are performing best with your audience.

GET

/api/v1/WhatsappMessageAnalytics/contacts/top

Identify your most engaged and active contacts.

PARAMETERTYPEDEFAULTDESCRIPTION
limitint10Number of top contacts to retrieve
GET

/api/v1/WhatsappMessageAnalytics/export

Download a detailed CSV report containing the status of every single 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.csv
GET

/api/v1/WhatsappMessageAnalytics/tracking-limits

Check your official WhatsApp messaging limits and monitor your sending capacity.

← PreviousWhatsapp Templates Next →Campaigns