SUMMARY

REST API Method: SUMMARY

Returns a list of usage totals by country, date, and device.

URL:

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

HTTP Method(s):

GET

Query String Parameters:

days - Integer. Required

customer - String. Optional

corporateCampaignId - String. Optional

Examples:

https://api.mailmonitorapp.com/mma/opentracker/summary?days=7

Returns usage about 7 days ago

Response:

JSON usage summary object with the following fields:

    • countryOpenEventCounts: Open events grouped by country

    • dailyOpenEventCounts: Open events grouped by day

    • deviceOpenEventCounts: Open events grouped by device

JSON example response:

{

"countryOpenEventCounts": [

{

"count": 1,

"country": "Dominican Republic"

},

{

"count": 10,

"country": "United States"

}

],

"dailyOpenEventCounts": [

{

"count": 5,

"timestamp": "2021-08-27T00:00:00Z"

},

{

"count": 1,

"timestamp": "2021-08-28T00:00:00Z"

},

{

"count": 1,

"timestamp": "2021-08-30T00:00:00Z"

},

{

"count": 2,

"timestamp": "2021-08-31T00:00:00Z"

},

{

"count": 1,

"timestamp": "2021-09-01T00:00:00Z"

},

{

"count": 1,

"timestamp": "2021-09-02T00:00:00Z"

}

],

"deviceOpenEventCounts": [

{

"count": 4,

"device": ""

},

{

"count": 5,

"device": "Other"

},

{

"count": 2,

"device": "Personal computer"

}

]

}