← API Index
/api/stats/mailopens
Mail opens over time after a sendout (per hour or per day), for the opens chart of a Serienmail. Admin access only. Get the serieref values from stats/mailcampaigns.
Parameters
| Name |
Description |
Type |
| sid |
the serieref of the sendout (see stats/mailcampaigns) |
int |
| p |
bucket size: h = per hour, first 72 hours (default); d = per day, 90 days |
string |
| 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 |
| 400 |
bad_request |
No valid sid given |
| 403 |
not_auth |
Not authenticated or no admin access |
Response Types
| Type |
Version |
Description |
| MailOpenStat |
1 |
Mail opens in one time bucket (hour or day) after a sendout |
OpenAPI
See mailopens.yaml
Referenced in skills