API Reference‎ > ‎Report Service‎ > ‎

Summary

REST API Method: summary

Returns an array of campaign summary objects.

 

URL:

https://api.mailmonitorapp.com/mma/report/summary


HTTP Method(s):

GET


Query String Parameters:

days integer (default 7) --

    number of days for which to fetch data.  If days = 5, fetch data for past 5 days.

    example:

domain string --

    return results for this domain.  If omitted, call returns results for all domains in account.

campaign string --

    return results for this campaign.  The value for this argument should be the campaign id used in an X-campaignid header.  If omitted, call returns results for all domains in account. [Added in API v1.3]


Note: the domain and campaign parameters are mutually exclusive.  If the domain parameter is supplied, the campaign parameter will be ignored.  


Examples:

https://api.mailmonitorapp.com/mma/report/summary?days=3

https://api.mailmonitorapp.com/mma/report/summary?domain=example.com&days=5

https://api.mailmonitorapp.com/mma/report/summary?campaign=camp13433xxd3


Response

JSON array of campaign summary objects.  Each campaign summary object has a report id that can be extracted and used to access more detailed reports.  Each campaign summary object has the following fields:

  • reportID: number
  • emailFrom: from header in email
  • emailSubject: subject header in email
  • reportCreated: date when emails were received
  • totalInbox: percentage of messages that were delivered to the inbox
  • currentlyCollecting: if 1, then data is still being collected for this campaign
  • campaignID: if x-header or html tab validation is used, the ID associated


          JSON example response (truncated):

 [ {

    "reportID":12812,

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

    "emailSubject":"Daily Deal for Wed",

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

    "totalInbox":78.8461500000,

    "currentlyCollecting":1

     },

    ...

]


Comments