-
Notifications
You must be signed in to change notification settings - Fork 3.8k
/
reports.json
559 lines (559 loc) · 18.2 KB
/
reports.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
{
"type": "object",
"title": "Campaign Reports",
"description": "A list of reports containing campaigns marked as Sent.",
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"description": "A string that uniquely identifies this campaign."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign.",
"readOnly": true
},
"type": {
"type": "string",
"title": "Campaign Type",
"description": "The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto)."
},
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id.",
"readOnly": true
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"description": "The status of the list used, namely if it's deleted or disabled.",
"readOnly": true
},
"list_name": {
"type": "string",
"title": "List Name",
"description": "The name of the list.",
"readOnly": true
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign.",
"readOnly": true
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"description": "The total number of emails sent for this campaign."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "The number of abuse reports generated for this campaign."
},
"unsubscribed": {
"type": "integer",
"title": "Unsubscribe Count",
"description": "The total number of unsubscribed members for this campaign.",
"readOnly": true
},
"send_time": {
"type": "string",
"format": "date-time",
"title": "Send Time",
"description": "The date and time a campaign was sent in ISO 8601 format.",
"readOnly": true
},
"rss_last_send": {
"type": "string",
"format": "date-time",
"title": "RSS Last Send",
"description": "For RSS campaigns, the date and time of the last send in ISO 8601 format.",
"readOnly": true
},
"bounces": {
"type": "object",
"title": "Bounces",
"description": "An object describing the bounce summary for the campaign.",
"properties": {
"hard_bounces": {
"type": "integer",
"title": "Hard Bounces",
"description": "The total number of hard bounced email addresses."
},
"soft_bounces": {
"type": "integer",
"title": "Soft Bounces",
"description": "The total number of soft bounced email addresses."
},
"syntax_errors": {
"type": "integer",
"title": "Syntax Errors",
"description": "The total number of addresses that were syntax-related bounces."
}
}
},
"forwards": {
"type": "object",
"title": "Forwards",
"description": "An object describing the forwards and forward activity for the campaign.",
"properties": {
"forwards_count": {
"type": "integer",
"title": "Total Forwards",
"description": "How many times the campaign has been forwarded."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "How many times the forwarded campaign has been opened."
}
}
},
"opens": {
"type": "object",
"title": "Opens",
"description": "An object describing the open activity for the campaign.",
"properties": {
"opens_total": {
"type": "integer",
"title": "Total Opens",
"description": "The total number of opens for a campaign."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The total number of unique opens."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"last_open": {
"type": ["null", "string"],
"format": "date-time",
"title": "Last Open",
"description": "The date and time of the last recorded open in ISO 8601 format."
}
}
},
"clicks": {
"type": "object",
"title": "Clicks",
"description": "An object describing the click activity for the campaign.",
"properties": {
"clicks_total": {
"type": "integer",
"title": "Total Clicks",
"description": "The total number of clicks for the campaign."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"description": "The total number of unique clicks for links across a campaign."
},
"unique_subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"description": "The total number of subscribers who clicked on a campaign."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"last_click": {
"type": ["null", "string"],
"format": "date-time",
"title": "Last Click",
"description": "The date and time of the last recorded click for the campaign in ISO 8601 format."
}
}
},
"facebook_likes": {
"type": "object",
"title": "Facebook Likes",
"description": "An object describing campaign engagement on Facebook.",
"properties": {
"recipient_likes": {
"type": "integer",
"title": "Recipient Likes",
"description": "The number of recipients who liked the campaign on Facebook."
},
"unique_likes": {
"type": "integer",
"title": "Unique Likes",
"description": "The number of unique likes."
},
"facebook_likes": {
"type": "integer",
"title": "Facebook Likes",
"description": "The number of Facebook likes for the campaign."
}
}
},
"industry_stats": {
"type": "object",
"title": "Industry Stats",
"description": "The average campaign statistics for your industry.",
"properties": {
"type": {
"type": "string",
"title": "Industry Type",
"description": "The type of business industry associated with your account. For example: retail, education, etc."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"description": "The industry open rate."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"description": "The industry click rate."
},
"bounce_rate": {
"type": "number",
"title": "Bounce Rate",
"description": "The industry bounce rate."
},
"unopen_rate": {
"type": "number",
"title": "Unopened Rate",
"description": "The industry unopened rate."
},
"unsub_rate": {
"type": "number",
"title": "Unsubscribe Rate",
"description": "The industry unsubscribe rate."
},
"abuse_rate": {
"type": "number",
"title": "Abuse Rate",
"description": "The industry abuse rate."
}
}
},
"list_stats": {
"type": "object",
"title": "List Stats",
"description": "The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list.",
"properties": {
"sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"description": "The average number of subscriptions per month for the list.",
"readOnly": true
},
"unsub_rate": {
"type": "number",
"title": "Average Unsubscription Rate",
"description": "The average number of unsubscriptions per month for the list.",
"readOnly": true
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"description": "The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list.",
"readOnly": true
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"description": "The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list.",
"readOnly": true
}
}
},
"ab_split": {
"type": "object",
"title": "A/B Split Stats",
"description": "General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns.",
"properties": {
"a": {
"type": "object",
"title": "Campaign A",
"description": "Stats for Campaign A.",
"properties": {
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "Bounces for Campaign A."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "Abuse reports for Campaign A."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"description": "Unsubscribes for Campaign A."
},
"recipient_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "Recipient Clicks for Campaign A."
},
"forwards": {
"type": "integer",
"title": "Forwards",
"description": "Forwards for Campaign A."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "Opens from forwards for Campaign A."
},
"opens": {
"type": "integer",
"title": "Opens",
"description": "Opens for Campaign A."
},
"last_open": {
"type": "string",
"title": "Last Open",
"description": "The last open for Campaign A."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "Unique opens for Campaign A."
}
}
},
"b": {
"type": "object",
"title": "Campaign B",
"description": "Stats for Campaign B.",
"properties": {
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "Bounces for Campaign B."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "Abuse reports for Campaign B."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"description": "Unsubscribes for Campaign B."
},
"recipient_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "Recipients clicks for Campaign B."
},
"forwards": {
"type": "integer",
"title": "Forwards",
"description": "Forwards for Campaign B."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "Opens for forwards from Campaign B."
},
"opens": {
"type": "integer",
"title": "Opens",
"description": "Opens for Campaign B."
},
"last_open": {
"type": "string",
"title": "Last Open",
"description": "The last open for Campaign B."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "Unique opens for Campaign B."
}
}
}
}
},
"timewarp": {
"type": "array",
"title": "Timewarp Stats",
"description": "An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp.",
"items": {
"type": "object",
"properties": {
"gmt_offset": {
"type": "integer",
"title": "GMT Offset",
"description": "For campaigns sent with timewarp, the time zone group the member is apart of."
},
"opens": {
"type": "integer",
"title": "Opens",
"description": "The number of opens."
},
"last_open": {
"type": "string",
"format": "date-time",
"title": "Last Open",
"description": "The date and time of the last open in ISO 8601 format."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The number of unique opens."
},
"clicks": {
"type": "integer",
"title": "Clicks",
"description": "The number of clicks."
},
"last_click": {
"type": "string",
"format": "date-time",
"title": "Last Click",
"description": "The date and time of the last click in ISO 8601 format."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"description": "The number of unique clicks."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "The number of bounces."
}
}
}
},
"timeseries": {
"type": "array",
"title": "Timeseries",
"description": "An hourly breakdown of the performance of the campaign over the first 24 hours.",
"items": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp",
"description": "The date and time for the series in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"description": "The number of emails sent in the timeseries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The number of unique opens in the timeseries."
},
"recipients_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "The number of clicks in the timeseries."
}
}
}
},
"share_report": {
"type": "object",
"title": "Share Report",
"description": "The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/).",
"properties": {
"share_url": {
"type": "string",
"title": "Report URL",
"description": "The URL for the VIP report.",
"readOnly": true
},
"share_password": {
"type": "string",
"title": "Report Password",
"description": "If password protected, the password for the VIP report.",
"readOnly": true
}
}
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"description": "E-Commerce stats for a campaign.",
"properties": {
"total_orders": {
"type": "integer",
"title": "Total Orders",
"description": "The total orders for a campaign.",
"readOnly": true
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions.",
"readOnly": true
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals.",
"readOnly": true
},
"currency_code": {
"type": "string",
"title": "Three letter currency code for this user",
"readOnly": true,
"example": "USD"
}
}
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"description": "Updates on campaigns in the process of sending.",
"properties": {
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"description": "Whether Campaign Delivery Status is enabled for this account and campaign.",
"readOnly": true
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"description": "Whether a campaign send can be canceled.",
"readOnly": true
},
"status": {
"type": "string",
"title": "Campaign Delivery Status",
"description": "The current state of a campaign delivery.",
"enum": ["delivering", "delivered", "canceling", "canceled"],
"readOnly": true
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"description": "The total number of emails confirmed sent for this campaign so far.",
"readOnly": true
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"description": "The total number of emails canceled for this campaign.",
"readOnly": true
}
}
}
}
}