User can retrieve primary statistical metrics on all newsletters sent to a specific list of contacts. Statistics include start and finish times; number of recipients and their preferred format; bounces and opens; links clicked; and others. 

Note:  This API call can also be found under the requesttype of "Stats".

XML Request Example:     

<?xml version="1.0" encoding="UTF-8"?>
       <list>123456</list>  <!-- required -->

<xmlrequest> element

Field NameDescription
usernameUsername used to login to Pinpointe
usertokenUnique token assigned to Pinpointe account

<details> element

Field Name
List ID

Successful Response:

<response> element

Field NameDescription
statusWill return SUCCESS if newsletter(s) stats are successfully retrieved.

<response> <data> <item> element  (primary elements)

Field NameDescription
statidStatistical report ID for this newsletter
starttimeStart time of send in UNIX time format
finishtime End time of send in UNIX time format
sendsizeNumber of contacts newsletter was sent to 
bouncecount_softNumber of reported soft bounces
bouncecount_hardNumber of reported hard bounces
bouncecount_unknownNumber of reported unknown bounces
unsubscribecountNumber of unsubscribes
emailopensNumber of opens
linkclicksNumber of link clicks
emailforwardsNumber of email forwards
subjectSubject of newsletter
newsletternameName of newsletter
listnameList name contact population belongs to

Unsuccessful Response:

<response> element

Field NameDescription
statusWill return FAILED if unsuccessful
errormessageText explaining why request failed