GET /api/analytics/overview Returns a comprehensive analytics overview including a summary of notification metrics, time series data, channel breakdown, and template breakdown for the specified date range.

​
Headers

​
appid
string
required
Your CometChat App ID.
​
apikey
string
required
Your CometChat API Key.

​
Query parameters

​
from
string
required
Start date in ISO 8601 format.
​
to
string
required
End date in ISO 8601 format.
​
granularity
string
default:"daily"
Time series granularity: hourly or daily.

​
Example request

curl "https://{appId}.api-{region}.cometchat.io/v3/business-messaging/api/analytics/overview?from=2024-01-01T00:00:00Z&to=2024-01-31T23:59:59Z&granularity=daily" \
  -H "appid: YOUR_APP_ID" \
  -H "apikey: YOUR_API_KEY"

​
Example response

{
  "summary": {
    "delivered": 15000,
    "viewed": 8500,
    "clicked": 3200
  },
  "timeSeries": [
    {
      "date": "2024-01-01",
      "delivered": 500,
      "viewed": 280,
      "clicked": 100
    }
  ],
  "channelBreakdown": [
    {
      "channelType": "in_app",
      "delivered": 10000,
      "viewed": 6000,
      "clicked": 2500
    },
    {
      "channelType": "push",
      "delivered": 5000,
      "viewed": 2500,
      "clicked": 700
    }
  ],
  "templateBreakdown": [
    {
      "templateId": "665b2c3d4e5f6a7b8c9d0e1f",
      "templateName": "Order Confirmation",
      "delivered": 8000,
      "viewed": 4500,
      "clicked": 1800
    }
  ]
}

​
Response fields

​
summary
object
Aggregate counts for delivered, viewed, and clicked events across the date range.
​
timeSeries
object[]
Array of data points at the requested granularity, each with date, delivered, viewed, and clicked counts.
​
channelBreakdown
object[]
Per-channel-type metrics with channelType, delivered, viewed, and clicked.
​
templateBreakdown
object[]
Per-template metrics with templateId, templateName, delivered, viewed, and clicked.