API Reference‎ > ‎Report Service‎ > ‎

Duration

REST API Method: duration

Returns a delivery duration report, for the given report id, that details the time interval when campaign emails were received for each mail destination.

 

URL:

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


HTTP Method(s):

GET


Path Parameter:

reportid integer --

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


Examples:

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


Response

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

  • reportID: number
  • emailFrom: from header in email
  • emailSubject: subject header in email
  • reportCreated: date when emails were received
  • totalMinTime: earliest time when campaign emails were received by any destination
  • totalMaxTime: latest time when campaign emails were received by any destination
  • totalElapsedTime: time difference between totalMinTime and totalMaxTime
  • currentlyCollecting: if 1, then data is still being collected for this campaign
  • destinations: JSON array of duration report objects.  Each duration report object has the following fields
    • name: name of destination
    • maxTime: latest time when campaign emails were received by this destination
    • minTime: earliest time when campaign emails were received by this destination
    • elapsedTime: time difference between minTime and maxTime

          JSON example response:


{
    "reportID":12812,
    "emailFrom":"sender@example.com",
    "emailSubject":"Daily Deal for Wed",
    "reportCreated":"2011-11-23",
    "totalMinTime":"2011-11-23 05:03:48",
    "totalMaxTime":"2011-11-23 13:44:50",
    "totalElapsedTime":"8h : 41m : 2s ",
    "currentlyCollecting":0,
    "destinations": [
        {
            "name":"gmail",
            "maxTime":"2011-11-23 05:16:32",
            "minTime":"2011-11-23 05:10:12",
            "elapsedTime":"0h : 6m : 20s "
        },
        {
            "name":"yahoo",
            "maxTime":"2011-11-23 05:54:08",
            "minTime":"2011-11-23 05:06:08",
            "elapsedTime":"0h : 48m : 0s "
        },
        {
            "name":"aol",
            "maxTime":"2011-11-23 13:44:50",
            "minTime":"2011-11-23 05:07:10",
            "elapsedTime":"8h : 37m : 40s "
        },
        {
            "name":"hotmail",
            "maxTime":"2011-11-23 05:50:37",
            "minTime":"2011-11-23 05:06:18",
            "elapsedTime":"0h : 44m : 19s "
        },
        {
            "name":"apple",
            "maxTime":"2011-11-23 05:03:50",
            "minTime":"2011-11-23 05:03:48",
            "elapsedTime":"0h : 0m : 2s "
        },
        {
            "name":"comcast",
            "maxTime":"2011-11-23 05:07:17",
            "minTime":"2011-11-23 05:05:48",
            "elapsedTime":"0h : 1m : 29s "
        },
        {
            "name":"roadrunner",
            "maxTime":"2011-11-23 05:05:58",
            "minTime":"2011-11-23 05:05:54",
            "elapsedTime":"0h : 0m : 4s "
        },
        {
            "name":"cox",
            "maxTime":"2011-11-23 05:05:51",
            "minTime":"2011-11-23 05:05:49",
            "elapsedTime":"0h : 0m : 2s "
        }
    ]
}
Comments