Resource

Analytics

Read-only aggregated metrics with sensible defaults and tight cardinality.

#About

Need per-row data? Use the messages, campaigns and inbox endpoints — they stream every message status update via webhook too.

#Endpoints

GET/analyticsAggregate analytics across messages, campaigns and conversations.

GET/analytics

Aggregate analytics across messages, campaigns and conversations.

SDK

TypeScript

const a = await zaptick.analytics.get({
  timeRange: 'month',
  from: '2026-04-01',
  to:   '2026-04-30',
});

Response

JSON

{
  "messageTrends": [
    { "date": "2026-04-01", "sent": 1240, "delivered": 1198, "read": 902 }
  ],
  "campaignSummary": { "launched": 8, "totalSent": 148230, "avgReadRate": 0.61 },
  "cost": { "totalCredits": 3918.22, "currency": "USD" },
  "topCountries": [{ "country": "IN", "sent": 92144 }],
  "peakHours": [{ "hour": 19, "sent": 18420 }],
  "insights": [
    { "type": "positive", "message": "Read rate up 8% vs last month." }
  ]
}