REST API Method: delivery

Returns a delivery report, for the given report id, that gives the inbox, spam, and not-received percentages for each mail destination.

URL:

https://api.mailmonitorapp.com/mma/report/delivery/${reportid}

HTTP Method(s):

GET

Path Parameter:

reportid integer --

The id of the campaign. The call returns delivery report information for this campaign.

Examples:

https://api.mailmonitorapp.com/mma/report/delivery/12812

Response:

JSON delivery report object. Each delivery report object has the following fields:

• • reportID: number

  • emailFrom: from header in email

  • emailBody: raw html body of email

  • emailSubject: subject header in email

  • reportCreated: date when emails were received

  • totalInbox: percentage of messages that were delivered to the inbox

  • totalSpam: percentage of messages that were delivered to the spam folder

  • totalLost: percentage of messages that were not received

  • currentlyCollecting: if 1, then data is still being collected for this campaign

  • destinations: JSON array of destination report objects. Each destination report object has the following fields

    • name: name of destination ISP

    • inboxCount: percentage of messages delivered to inbox

    • spamCount: percentage of messages delivered to spam folder

    • lostCount: percentage of messages not received

    • seedNumber: number of seeds for that ISP

    • inboxNumber: number of seeds delivered to the inbox

    • spamNumber: number of seeds delivered to the spam/bulk folder

JSON example response:

{

"reportID":12812,

"emailFrom":"sender@example.com",

"emailSubject":"Daily Deal for Wed",

"reportCreated":"2011-11-23",

"totalInbox":78.8461500000,

"totalSpam":21.1538375000,

"totalLost":0.0000125000,

"currentlyCollecting":0,

"destinations":[

{"name":"gmail","inboxCount":0.000000,"spamCount":100.000000,"lostCount":0.000000,"seedNumber":26, "inboxNumber":0,"spamNumber":26},

{"name":"yahoo","inboxCount":100.000000,"spamCount":0.000000,"lostCount":0.000000,"seedNumber":26, "inboxNumber":26,"spamNumber":0},

{"name":"aol","inboxCount":30.769200,"spamCount":69.230700,"lostCount":0.000000,"seedNumber":26, "inboxNumber":10,"spamNumber":16},

{"name":"hotmail","inboxCount":100.000000,"spamCount":0.000000,"lostCount":0.000000,"seedNumber":26, "inboxNumber":26,"spamNumber":0},

{"name":"apple","inboxCount":100.000000,"spamCount":0.000000,"lostCount":0.000000,"seedNumber":12, "inboxNumber":12,"spamNumber":0},

{"name":"comcast","inboxCount":100.000000,"spamCount":0.000000,"lostCount":0.000000,"seedNumber":12, "inboxNumber":12,"spamNumber":0},

{"name":"roadrunner","inboxCount":100.000000,"spamCount":0.000000,"lostCount":0.000000,"seedNumber":12, "inboxNumber":12,"spamNumber":0},

{"name":"cox","inboxCount":100.000000,"spamCount":0.000000,"lostCount":0.000000,"seedNumber":12, "inboxNumber":12,"spamNumber":0}

]

}