|
3 | 3 | "type": ["null", "object"],
|
4 | 4 | "properties": {
|
5 | 5 | "appId": {
|
| 6 | + "description": "The unique identifier of the application associated with the campaign data.", |
6 | 7 | "type": ["null", "integer"]
|
7 | 8 | },
|
8 | 9 | "appName": {
|
| 10 | + "description": "The name of the application associated with the campaign data.", |
9 | 11 | "type": ["null", "string"]
|
10 | 12 | },
|
11 | 13 | "contentId": {
|
| 14 | + "description": "The unique identifier of the content associated with the campaign.", |
12 | 15 | "type": ["null", "integer"]
|
13 | 16 | },
|
14 | 17 | "counters": {
|
| 18 | + "description": "Object containing different counters related to the campaign's performance.", |
15 | 19 | "type": ["null", "object"],
|
16 | 20 | "properties": {
|
17 | 21 | "open": {
|
| 22 | + "description": "Number of email opens.", |
18 | 23 | "type": ["null", "integer"]
|
19 | 24 | },
|
20 | 25 | "processed": {
|
| 26 | + "description": "Number of emails processed by the campaign.", |
21 | 27 | "type": ["null", "integer"]
|
22 | 28 | },
|
23 | 29 | "sent": {
|
| 30 | + "description": "Number of emails sent.", |
24 | 31 | "type": ["null", "integer"]
|
25 | 32 | },
|
26 | 33 | "deferred": {
|
| 34 | + "description": "Number of deferred emails.", |
27 | 35 | "type": ["null", "integer"]
|
28 | 36 | },
|
29 | 37 | "unsubscribed": {
|
| 38 | + "description": "Number of recipients unsubscribed from the campaign.", |
30 | 39 | "type": ["null", "integer"]
|
31 | 40 | },
|
32 | 41 | "statuschange": {
|
| 42 | + "description": "Number of status changes related to the campaign.", |
33 | 43 | "type": ["null", "integer"]
|
34 | 44 | },
|
35 | 45 | "bounce": {
|
| 46 | + "description": "Number of bounced emails.", |
36 | 47 | "type": ["null", "integer"]
|
37 | 48 | },
|
38 | 49 | "mta_dropped": {
|
| 50 | + "description": "Number of emails dropped at the MTA level.", |
39 | 51 | "type": ["null", "integer"]
|
40 | 52 | },
|
41 | 53 | "dropped": {
|
| 54 | + "description": "Number of dropped emails.", |
42 | 55 | "type": ["null", "integer"]
|
43 | 56 | },
|
44 | 57 | "suppressed": {
|
| 58 | + "description": "Number of emails suppressed from sending.", |
45 | 59 | "type": ["null", "integer"]
|
46 | 60 | },
|
47 | 61 | "click": {
|
| 62 | + "description": "Number of clicks on the campaign.", |
48 | 63 | "type": ["null", "integer"]
|
49 | 64 | },
|
50 | 65 | "delivered": {
|
| 66 | + "description": "Number of successfully delivered emails.", |
51 | 67 | "type": ["null", "integer"]
|
52 | 68 | },
|
53 | 69 | "forward": {
|
| 70 | + "description": "Number of emails forwarded by recipients.", |
54 | 71 | "type": ["null", "integer"]
|
55 | 72 | },
|
56 | 73 | "print": {
|
| 74 | + "description": "Number of emails printed by recipients.", |
57 | 75 | "type": ["null", "integer"]
|
58 | 76 | },
|
59 | 77 | "reply": {
|
| 78 | + "description": "Number of replies received to the campaign.", |
60 | 79 | "type": ["null", "integer"]
|
61 | 80 | },
|
62 | 81 | "spamreport": {
|
| 82 | + "description": "Number of spam reports received for the campaign.", |
63 | 83 | "type": ["null", "integer"]
|
64 | 84 | }
|
65 | 85 | }
|
66 | 86 | },
|
67 | 87 | "counters_open": {
|
| 88 | + "description": "Alias for the open counter value.", |
68 | 89 | "type": ["null", "integer"]
|
69 | 90 | },
|
70 | 91 | "counters_processed": {
|
| 92 | + "description": "Alias for the processed counter value.", |
71 | 93 | "type": ["null", "integer"]
|
72 | 94 | },
|
73 | 95 | "counters_sent": {
|
| 96 | + "description": "Alias for the sent counter value.", |
74 | 97 | "type": ["null", "integer"]
|
75 | 98 | },
|
76 | 99 | "counters_deferred": {
|
| 100 | + "description": "Alias for the deferred counter value.", |
77 | 101 | "type": ["null", "integer"]
|
78 | 102 | },
|
79 | 103 | "counters_unsubscribed": {
|
| 104 | + "description": "Alias for the unsubscribed counter value.", |
80 | 105 | "type": ["null", "integer"]
|
81 | 106 | },
|
82 | 107 | "counters_statuschange": {
|
| 108 | + "description": "Alias for the status change counter value.", |
83 | 109 | "type": ["null", "integer"]
|
84 | 110 | },
|
85 | 111 | "counters_bounce": {
|
| 112 | + "description": "Alias for the bounce counter value.", |
86 | 113 | "type": ["null", "integer"]
|
87 | 114 | },
|
88 | 115 | "counters_mta_dropped": {
|
| 116 | + "description": "Alias for the MTA dropped counter value.", |
89 | 117 | "type": ["null", "integer"]
|
90 | 118 | },
|
91 | 119 | "counters_dropped": {
|
| 120 | + "description": "Alias for the dropped counter value.", |
92 | 121 | "type": ["null", "integer"]
|
93 | 122 | },
|
94 | 123 | "counters_suppressed": {
|
| 124 | + "description": "Alias for the suppressed counter value.", |
95 | 125 | "type": ["null", "integer"]
|
96 | 126 | },
|
97 | 127 | "counters_click": {
|
| 128 | + "description": "Alias for the click counter value.", |
98 | 129 | "type": ["null", "integer"]
|
99 | 130 | },
|
100 | 131 | "counters_delivered": {
|
| 132 | + "description": "Alias for the delivered counter value.", |
101 | 133 | "type": ["null", "integer"]
|
102 | 134 | },
|
103 | 135 | "counters_forward": {
|
| 136 | + "description": "Alias for the forward counter value.", |
104 | 137 | "type": ["null", "integer"]
|
105 | 138 | },
|
106 | 139 | "counters_print": {
|
| 140 | + "description": "Alias for the print counter value.", |
107 | 141 | "type": ["null", "integer"]
|
108 | 142 | },
|
109 | 143 | "counters_reply": {
|
| 144 | + "description": "Alias for the reply counter value.", |
110 | 145 | "type": ["null", "integer"]
|
111 | 146 | },
|
112 | 147 | "counters_spamreport": {
|
| 148 | + "description": "Alias for the spam report counter value.", |
113 | 149 | "type": ["null", "integer"]
|
114 | 150 | },
|
115 | 151 | "id": {
|
| 152 | + "description": "The unique identifier of the campaign.", |
116 | 153 | "type": ["null", "integer"]
|
117 | 154 | },
|
118 | 155 | "lastProcessingFinishedAt": {
|
| 156 | + "description": "Timestamp indicating when the last processing of the campaign was finished.", |
119 | 157 | "type": ["null", "integer"]
|
120 | 158 | },
|
121 | 159 | "lastProcessingStateChangeAt": {
|
| 160 | + "description": "Timestamp indicating the last state change time of the processing state.", |
122 | 161 | "type": ["null", "integer"]
|
123 | 162 | },
|
124 | 163 | "lastProcessingStartedAt": {
|
| 164 | + "description": "Timestamp indicating when the last processing of the campaign started.", |
125 | 165 | "type": ["null", "integer"]
|
126 | 166 | },
|
127 | 167 | "processingState": {
|
| 168 | + "description": "Current processing state of the campaign.", |
128 | 169 | "type": ["null", "string"]
|
129 | 170 | },
|
130 | 171 | "name": {
|
| 172 | + "description": "The name of the campaign.", |
131 | 173 | "type": ["null", "string"]
|
132 | 174 | },
|
133 | 175 | "numIncluded": {
|
| 176 | + "description": "Number of recipients included in the campaign.", |
134 | 177 | "type": ["null", "integer"]
|
135 | 178 | },
|
136 | 179 | "numQueued": {
|
| 180 | + "description": "Number of emails queued for sending.", |
137 | 181 | "type": ["null", "integer"]
|
138 | 182 | },
|
139 | 183 | "subType": {
|
| 184 | + "description": "Subtype of the campaign.", |
140 | 185 | "type": ["null", "string"]
|
141 | 186 | },
|
142 | 187 | "subject": {
|
| 188 | + "description": "The subject line of the campaign.", |
143 | 189 | "type": ["null", "string"]
|
144 | 190 | },
|
145 | 191 | "type": {
|
| 192 | + "description": "Type classification of the campaign.", |
146 | 193 | "type": ["null", "string"]
|
147 | 194 | },
|
148 | 195 | "lastUpdatedTime": {
|
| 196 | + "description": "Timestamp indicating when the campaign data was last updated.", |
149 | 197 | "type": ["null", "integer"]
|
150 | 198 | }
|
151 | 199 | }
|
|
0 commit comments