GET
/
analytics
/
campaigns
cURL
curl --request GET \
  --url https://api.wapikit.com/api/analytics/campaigns
{
  "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

​
from
string<date-time>
required

starting range of time span to get analytics for

​
to
string<date-time>
required

ending range of time span to get analytics for

Response

messaging analytics graph data points

The response is of type object.