Skip to content

Commit 09496a3

Browse files
committed
feat: Add notification per-platform delivery stats for email and SMS
- Added descriptions to existing properties under GET notification DeliveryData component schema - Added new properties to GET notification PlatformDeliveryData schema for SMS and email that are unique to those channels
1 parent 9934a10 commit 09496a3

1 file changed

Lines changed: 77 additions & 0 deletions

File tree

api.json

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1156,6 +1156,78 @@
11561156
},
11571157
"ios": {
11581158
"$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+
]
11591231
}
11601232
}
11611233
},
@@ -1164,22 +1236,27 @@
11641236
"properties": {
11651237
"successful": {
11661238
"type": "integer",
1239+
"description": "Number of messages delivered to push servers, mobile carriers, or email service providers.",
11671240
"nullable": true
11681241
},
11691242
"failed": {
11701243
"type": "integer",
1244+
"description": "Number of messages sent to unsubscribed devices.",
11711245
"nullable": true
11721246
},
11731247
"errored": {
11741248
"type": "integer",
1249+
"description": "Number of errors reported.",
11751250
"nullable": true
11761251
},
11771252
"converted": {
11781253
"type": "integer",
1254+
"description": "Number of messages that were clicked.",
11791255
"nullable": true
11801256
},
11811257
"received": {
11821258
"type": "integer",
1259+
"description": "Number of devices that received the message.",
11831260
"nullable": true
11841261
}
11851262
}

0 commit comments

Comments
 (0)