API Reference‎ > ‎Usage Service‎ > ‎

SubAccount

REST API Method: subaccount

Returns a usage summary for each subaccount for the date range defined by the arguments 'fromdate' and 'untildate'

 

URL:

https://api.mailmonitorapp.com/mma/usage/subaccount


HTTP Method(s):

GET


Query String Parameters:

fromdate - ISO-8601 date string (YYYY-MM-DD, e.g. 2020-04-29). Required.

untildate - ISO-8601 date string (YYYY-MM-DD, e.g. 2020-04-29). Optional.

Note: usage data will be inclusive of the date arguments.


Examples:

https://api.mailmonitorapp.com/mma/usage/subaccount?fromdate=2020-04-29

Returns subaccount usage from 2020-04-29 to present

https://api.mailmonitorapp.com/mma/usage/subaccount?fromdate=2020-04-01&untildate=2020-04-30

Returns subaccount usage for April 2020.


Response: 

An array of JSON usage summary objects with the following fields:

  • campaignCount: number seed tests executed
  • dnsblHits: number of dnsbl hits
  • spamtrapDomainHits: number of spamtrap hits for registered domains
  • spamtrapIpHits: number of spamtrap hits for registered IP addresses
  • tabTrackingCount: number of email tab tests executed
  • previewCount: number of email preview tests executed
  • email: the email address for the subaccount


          JSON example response (truncated):

[
{
    "campaignCount":126
    "dnsblHits":1,
    "spamtrapDomainHits":1,
    "spamtrapIpHits":0,
    "tabTrackingCount":10,
    "previewCount":10,
    "email":"abc@example.com"
},
{
    "campaignCount":16
    "dnsblHits":10,
    "spamtrapDomainHits":5,
    "spamtrapIpHits":0,
    "tabTrackingCount":15,
    "previewCount":15,
    "email":"def@example.com"
},
...
]
Comments