To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Summarises email delivery and engagement outcomes for a date range, as counts and derived percentage rates. Built by EmailApp.emailStats(Date, Date) from EmailItem.countStats results, and read by the admin dashboard email widget (deliveryRatePerc, openRatePerc, convertedRatePerc) to render the delivered/opened/converted summary pies. All rate getters return null when their denominator is zero, so callers must handle a missing rate rather than assuming zero.
Properties
| Property | Returns | Description |
|---|---|---|
| converted | long | Number of email items in the range that were marked as converted (edmConverted), meaning the recipient clicked through and completed the tracked action. |
| convertedRatePerc | Integer | Proportion of successfully delivered email items in the range that converted, as a whole-number percentage of converted over deliveredOk. |
| deliveredOk | long | Number of email items in the range whose send status is EmailItem.STATUS_COMPLETE, meaning delivery succeeded. |
| deliveryRatePerc | Integer | Proportion of all email items in the range that were delivered successfully, as a whole-number percentage of deliveredOk over total. |
| failed | long | Number of email items in the range whose send status is EmailItem.STATUS_FAILED, meaning delivery did not succeed. |
| openRatePerc | Integer | Proportion of successfully delivered email items in the range that were read, as a whole-number percentage of read over deliveredOk. |
| read | long | Number of email items in the range that were marked as read by the recipient. |
| total | long | Total number of email items counted in the range, regardless of send, read or conversion status. |
Methods
getConverted()
Returns: long
Number of email items in the range that were marked as converted (edmConverted), meaning the recipient clicked through and completed the tracked action.
getRead()
Returns: long
Number of email items in the range that were marked as read by the recipient.
getTotal()
Returns: long
Total number of email items counted in the range, regardless of send, read or conversion status.
getDeliveredOk()
Returns: long
Number of email items in the range whose send status is EmailItem.STATUS_COMPLETE, meaning delivery succeeded.
getFailed()
Returns: long
Number of email items in the range whose send status is EmailItem.STATUS_FAILED, meaning delivery did not succeed.
getDeliveryRatePerc()
Returns: Integer
Proportion of all email items in the range that were delivered successfully, as a whole-number percentage of deliveredOk over total.
getOpenRatePerc()
Returns: Integer
Proportion of successfully delivered email items in the range that were read, as a whole-number percentage of read over deliveredOk.
getConvertedRatePerc()
Returns: Integer
Proportion of successfully delivered email items in the range that converted, as a whole-number percentage of converted over deliveredOk.
© 2025 Kademi Ltd