← API Index


MailCampaign (v2)

One message series (Serienmail, push or SMS series) with its delivery and engagement statistics

Change Note: adds channel and delivered

# Field Type Description
0 id int internal mailstats id
1 serieref int series reference (PCG serial reference, or the queue id for shop-created series); key for the per-series open/click charts, /readonline and message/series/cancel
2 campaignid int campaign id, 0 = info message (no campaign)
3 sent datetime start of the sendout
4 duration int sendout duration in seconds, 0 = still running
5 subject string mail subject / push title
6 total int number of messages processed
7 senderrors int errors during the sendout itself (push: no channel accepted the message)
8 uniquebounces int unique bounces after the sendout (mail)
9 uniqueopens int opened, counted once per reader (push: notification taps, once per push)
10 opens int opened, every open counted (push: every tap report)
11 unsubscribes int unsubscribes attributed to this sendout (mail)
12 clicks int link clicks, every click counted
13 unique_clicks int link clicks, counted once per reader
14 openrate double unique opens in percent of total
15 clickrate double unique clicks in percent of total
16 bouncerate double unique bounces in percent of total
17 last_updated datetime last (automatic) refresh of these numbers
18 archived bool true if the sendout was archived in the admin UI
19 channel string delivery channel of the series: mail, push, sms, or auto (best channel per recipient - see sent_mail/sent_push/sent_sms for the split)
20 delivered int delivery receipts (push: reported by the app, needs app-side analytics; 0 for mail)
21 sent_mail int messages that went out as mail
22 sent_push int messages that went out as push
23 sent_sms int messages that went out as SMS

Used in endpoints

Referenced in skills

Other versions