Skip to main content
GET
/
api
/
v1
/
campaigns
/
aggregate-stats
Get Aggregate Stats
curl --request GET \
  --url https://api.example.com/api/v1/campaigns/aggregate-stats \
  --header 'Authorization: Bearer <token>'
{
  "active_campaigns": 0,
  "total_campaigns": 0,
  "total_sent": 0,
  "total_delivered": 0,
  "total_opened": 0,
  "total_replied": 0,
  "total_bounced": 0,
  "avg_open_rate": "0.0",
  "avg_reply_rate": "0.0"
}

Authorizations

​
Authorization
string
header
required

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

Response

Successful Response

Response model for aggregate stats across all user campaigns.

​
active_campaigns
integer
default:0
​
total_campaigns
integer
default:0
​
total_sent
integer
default:0
​
total_delivered
integer
default:0
​
total_opened
integer
default:0
​
total_replied
integer
default:0
​
total_bounced
integer
default:0
​
avg_open_rate
string
default:0.0
​
avg_reply_rate
string
default:0.0