|
1156 | 1156 | }, |
1157 | 1157 | "ios": { |
1158 | 1158 | "$ref": "#/components/schemas/DeliveryData" |
| 1159 | + }, |
| 1160 | + "sms": { |
| 1161 | + "allOf": [ |
| 1162 | + { |
| 1163 | + "$ref": "#/components/schemas/DeliveryData" |
| 1164 | + }, |
| 1165 | + { |
| 1166 | + "properties": { |
| 1167 | + "provider_successful": { |
| 1168 | + "type": "integer", |
| 1169 | + "description": "Number of messages reported as delivered successfully by the SMS service provider.", |
| 1170 | + "nullable": true |
| 1171 | + }, |
| 1172 | + "provider_failed": { |
| 1173 | + "type": "integer", |
| 1174 | + "description": "Number of recipients who didn't receive your message as reported by the SMS service provider.", |
| 1175 | + "nullable": true |
| 1176 | + }, |
| 1177 | + "provider_errored": { |
| 1178 | + "type": "integer", |
| 1179 | + "description": "Number of errors reported by the SMS service provider.", |
| 1180 | + "nullable": true |
| 1181 | + } |
| 1182 | + } |
| 1183 | + } |
| 1184 | + ] |
| 1185 | + }, |
| 1186 | + "email": { |
| 1187 | + "allOf": [ |
| 1188 | + { |
| 1189 | + "$ref": "#/components/schemas/DeliveryData" |
| 1190 | + }, |
| 1191 | + { |
| 1192 | + "properties": { |
| 1193 | + "opened": { |
| 1194 | + "type": "integer", |
| 1195 | + "description": "Number of times an email has been opened.", |
| 1196 | + "nullable": true |
| 1197 | + }, |
| 1198 | + "unique_opens": { |
| 1199 | + "type": "integer", |
| 1200 | + "description": "Number of unique recipients who have opened your email.", |
| 1201 | + "nullable": true |
| 1202 | + }, |
| 1203 | + "clicks": { |
| 1204 | + "type": "integer", |
| 1205 | + "description": "Number of clicked links from your email. This can include the recipient clicking email links multiple times.", |
| 1206 | + "nullable": true |
| 1207 | + }, |
| 1208 | + "unique_clicks": { |
| 1209 | + "type": "integer", |
| 1210 | + "description": "Number of unique clicks that your recipients have made on links from your email.", |
| 1211 | + "nullable": true |
| 1212 | + }, |
| 1213 | + "bounced": { |
| 1214 | + "type": "integer", |
| 1215 | + "description": "Number of recipients who registered as a hard or soft bounce and didn't receive your email.", |
| 1216 | + "nullable": true |
| 1217 | + }, |
| 1218 | + "reported_spam": { |
| 1219 | + "type": "integer", |
| 1220 | + "description": "Number of recipients who reported this email as spam.", |
| 1221 | + "nullable": true |
| 1222 | + }, |
| 1223 | + "unsubscribed": { |
| 1224 | + "type": "integer", |
| 1225 | + "description": "Number of recipients who opted out of your emails using the unsubscribe link in this email.", |
| 1226 | + "nullable": true |
| 1227 | + } |
| 1228 | + } |
| 1229 | + } |
| 1230 | + ] |
1159 | 1231 | } |
1160 | 1232 | } |
1161 | 1233 | }, |
|
1164 | 1236 | "properties": { |
1165 | 1237 | "successful": { |
1166 | 1238 | "type": "integer", |
| 1239 | + "description": "Number of messages delivered to push servers, mobile carriers, or email service providers.", |
1167 | 1240 | "nullable": true |
1168 | 1241 | }, |
1169 | 1242 | "failed": { |
1170 | 1243 | "type": "integer", |
| 1244 | + "description": "Number of messages sent to unsubscribed devices.", |
1171 | 1245 | "nullable": true |
1172 | 1246 | }, |
1173 | 1247 | "errored": { |
1174 | 1248 | "type": "integer", |
| 1249 | + "description": "Number of errors reported.", |
1175 | 1250 | "nullable": true |
1176 | 1251 | }, |
1177 | 1252 | "converted": { |
1178 | 1253 | "type": "integer", |
| 1254 | + "description": "Number of messages that were clicked.", |
1179 | 1255 | "nullable": true |
1180 | 1256 | }, |
1181 | 1257 | "received": { |
1182 | 1258 | "type": "integer", |
| 1259 | + "description": "Number of devices that received the message.", |
1183 | 1260 | "nullable": true |
1184 | 1261 | } |
1185 | 1262 | } |
|
0 commit comments