API Documentation
- API Overview
- Events
- Organization
- User
- Auth
- Organization Members
- Contacts
- Lists
- Campaigns
- Conversations
- Messages
- Integrations
- Analytics
- Knowledge Base
- System
Analytics
Get analyticscampaigns
returns aggregate campaign analytics
GET
/
analytics
/
campaigns
Copy
curl --request GET \
--url https://api.wapikit.com/api/analytics/campaigns
Copy
{
"analytics": {
"totalRecipients": 123,
"messagesSent": 123,
"messagesFailed": 123,
"messagesDelivered": 123,
"messagesUndelivered": 123,
"messagesRead": 123,
"totalMessages": 123,
"conversationInitiated": 123,
"responseRate": 123,
"openRate": 123,
"engagementRate": 123,
"totalLinkClicks": 123,
"engagementTrends": [
{
"date": "2023-11-07T05:31:56Z",
"label": "<string>",
"count": 123
}
],
"linkClicksData": [
{
"date": "2023-11-07T05:31:56Z",
"label": "<string>",
"count": 123
}
],
"messageAnalytics": [
{
"date": "2023-11-07T05:31:56Z",
"label": "<string>",
"sent": 123,
"delivered": 123,
"replied": 123,
"read": 123
}
]
}
}
Query Parameters
starting range of time span to get analytics for
ending range of time span to get analytics for
Response
200
application/json
messaging analytics graph data points
The response is of type object
.
Was this page helpful?
Copy
curl --request GET \
--url https://api.wapikit.com/api/analytics/campaigns
Copy
{
"analytics": {
"totalRecipients": 123,
"messagesSent": 123,
"messagesFailed": 123,
"messagesDelivered": 123,
"messagesUndelivered": 123,
"messagesRead": 123,
"totalMessages": 123,
"conversationInitiated": 123,
"responseRate": 123,
"openRate": 123,
"engagementRate": 123,
"totalLinkClicks": 123,
"engagementTrends": [
{
"date": "2023-11-07T05:31:56Z",
"label": "<string>",
"count": 123
}
],
"linkClicksData": [
{
"date": "2023-11-07T05:31:56Z",
"label": "<string>",
"count": 123
}
],
"messageAnalytics": [
{
"date": "2023-11-07T05:31:56Z",
"label": "<string>",
"sent": 123,
"delivered": 123,
"replied": 123,
"read": 123
}
]
}
}
Assistant
Responses are generated using AI and may contain mistakes.