Questions? Feedback? powered by Olark live chat software

Newsman API Page

NewsmanSMTP API » NewsmanSMTP API 1.0 » Account

NewsmanSMTP API Listing


Method Description
live_counters Returns the counters for this account between "start_date" and "stop_date" grouped by "unit" without considering the send date of actions.
counters Returns the counters for this account between “start_date” and “stop_date” grouped by “unit”.

“start_date” and “stop_date” are the dates in your local timezone (format: YYYY-mm-dd or YYYY-mm-dd HH:MM:SS).
There must be max 180 days (~6 months) between “start_date” and “stop_date”

Returns a dictionary for each of the following actions: send, view, click, unsub, bounce, hardbounce, reject, spam.

For each action there is a dictionary returned with format:
   total: < int >
   utotal: < int >

“total” means the total number of “actions”
“utotal” means the unique number of “actions” (for example unique views)

If “unit” is “hours” for each day, details are added for each hour (unique and total):
   total: < int >
   utotal: < int >
      u: < int >
      t: < int >
      u: < int >
      t: < int >

If no information are found for a day or hour, the entry is listed with 0 for the totals.

The counters are calculated based on send_date. So if a view of a message sent yesterday is made today, the view counter incremented is for yesterday (send date).

tags Returns the list of tags associated to this account.


history Returns an array of actions descendant sorted for this account

Each entry of the result has the following format:
   action: < string >, # name of the action
   timestamp: < int >, # timestamp int representing the time of the action
   data: < dict >, # dictionary with action specific details