API Reference‎ > ‎Report Service‎ > ‎

Gmail Tab

REST API Method: summary

Returns an array of Gmail tab test results

 

URL:

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


HTTP Method(s):

GET


Query String Parameters:

dateFilter integer (default 7) -- 

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

    example: 

fromFilter string -- 

    filters results by any portion of the from address.  If omitted, call returns results for all results.

subjectLineFilter string --

    filters results by any portion of the subject line.  If omitted, call returns results for all results.


Examples:

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

https://api.mailmonitorapp.com/mma/report/summary?fromFilter=support@example.com&dateFilter=5

https://api.mailmonitorapp.com/mma/report/summary?subjectLineFilter=Sale!


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:

  • emailID: number
  • testDate: date test was received
  • emailFrom: from address used
  • emailSubject: subject line of email
  • gmailTabName: Gmail tab the email was delivered to (Primary, Social, Promotions)


          JSON example response (truncated):

 [ {

    "emailID":141559227,
    "testDate":"2013-11-19",
    "emailFrom":"support@example.com",
    "emailSubject":"Best deals of the year!",
    "gmailTabName":"Promotions"}

    ...

]

Comments