← API Index
/api/stats/mailcampaigns1
List all message series (Serienmails, push and SMS series) with their delivery and engagement statistics, newest first (up to 150). Admin access only. A series with duration = 0 is still running. Campaign series (campaignid > 0) link to per-week details via stats/campaign1.
Change Note: adds channel and delivered (MailCampaign v2) and the channel filter
Parameters
| Name |
Description |
Type |
| archived |
if true, include archived series (default: only active ones) |
bool |
| channel |
restrict to one channel: mail, push, sms or auto (default: all) |
string |
| sm_infomails |
if true, include info messages (campaignid = 0); default: campaigns only |
bool |
| oo-rf |
optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml |
String |
| oo-auth |
optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized. |
int |
Error Responses
| HTTP Status |
Error Code |
Description |
| 403 |
not_auth |
Not authenticated or no admin access |
Response Types
| Type |
Version |
Description |
| MailCampaign |
2 |
One message series (Serienmail, push or SMS series) with its delivery and engagement statistics |
OpenAPI
See mailcampaigns1.yaml
Referenced in skills
Other versions