try out ↗

← API Index


/api/stats/mailcampaigns

List all mail sendouts (Serienmails) with their delivery and engagement statistics, newest first (up to 150). Admin access only. Campaign sendouts (campaignid > 0) link to per-week details via stats/campaign1.

Parameters

Name Description Type
archived if true, include archived sendouts (default: only active ones) 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 1 One mail sendout (Serienmail) with its delivery and engagement statistics

OpenAPI

See mailcampaigns.yaml

Referenced in skills

Other versions