Skip to main content
GET
/
api
/
campaigns
/
analytics
Get campaign analytics for organization
curl --request GET \
  --url https://your-instance.example.com/api/campaigns/analytics \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "totalCampaigns": 123,
    "scheduledCount": 123,
    "sentCount": 123,
    "failedCount": 123,
    "partialSuccessCount": 123,
    "cancelledCount": 123,
    "segmentedCount": 123,
    "segmentedPercentage": "<string>",
    "totalMessages": 123,
    "sentMessages": 123,
    "scheduledMessages": 123,
    "failedMessages": 123,
    "overallSuccessRate": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Analytics returned

success
boolean
data
object