Skip to content
View as Markdown

GET Get Campaign Overview Stats​

GET
/campaigns/{id}/overview_stats

Get overview statistics for a campaign including sent count, email status breakdown, and open/click analytics. This is a lighter-weight alternative to the full campaign status endpoint, suitable for dashboard widgets or summary views.

Authorizations​

ApplicationPasswords

WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password

Type
API Key (header: Authorization)

Parameters​

Path Parameters

id*

The campaign ID.

Type
integer
Required

Responses​

Overview statistics retrieved successfully.

application/json
JSON
{
"sent_count": 0,
"stat": [
{
"status": "string",
"total": 0
}
],
"analytics": {
"open": {
"total": 0,
"subtitle": "string"
},
"click": {
"total": 0,
"subtitle": "string"
}
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI