API Reference‎ > ‎Usage Service‎ > ‎

Account

REST API Method: account

Returns a usage summary for the current account for the date range defined by the arguments 'fromdate' and 'untildate'

 

URL:

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


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/account?fromdate=2020-04-29

Returns usage from 2020-04-29 to present

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

Returns usage for April 2020.


Response

JSON usage summary object 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


          JSON example response:

{
    "campaignCount":126
    "dnsblHits":1,
    "spamtrapDomainHits":1,
    "spamtrapIpHits":0,
    "tabTrackingCount":10,
    "previewCount":10
}

Comments