Retrieves statistics from one contact list.
XML Request Example:
<?xml version="1.0" encoding="UTF-8"?> <xmlrequest> <username>cesystem</username> <usertoken>abc123abc123abc123abc123abc123abc123abc123abc123</usertoken> <requesttype>stats</requesttype> <requestmethod>getcampaignstats</requestmethod> <details> <listid>2</listid> </details> </xmlrequest>
<xmlrequest> element
Field Name | Description |
username | Username used to login to Pinpointe |
usertoken | Unique token assigned to Pinpointe account |
requesttype | Name of API set to be used |
requestmethod | Function being called |
<details> element
Field Name | Description |
listid | ID of contact list |
Successful Response:
<response> element
Field Name | Description |
status | Will return SUCCESS if user was successfully added |
data | One or more item elements. See sample below. For additional details, use statid with the API to get campaign summaries. |
Sample Response:
<?xml version="1.0" encoding="UTF-8"?> <response> <status>SUCCESS</status> <data> <item> <statid>7</statid> <starttime>1295589722</starttime> <finishtime>1295589722</finishtime> <htmlrecipients>0</htmlrecipients> <textrecipients>0</textrecipients> <multipartrecipients>1</multipartrecipients> <sendsize>1</sendsize> <bouncecount_soft>0</bouncecount_soft> <bouncecount_hard>0</bouncecount_hard> <bouncecount_unknown>0</bouncecount_unknown> <unsubscribecount>0</unsubscribecount> <newslettername>WarmEmailC</newslettername> <listname>'Preview List (Keep)'</listname> </item> <item> <statid>6</statid> <starttime>1295588881</starttime> <finishtime>1295588882</finishtime> <htmlrecipients>0</htmlrecipients> <textrecipients>0</textrecipients> <multipartrecipients>1</multipartrecipients> <sendsize>1</sendsize> <bouncecount_soft>0</bouncecount_soft> <bouncecount_hard>0</bouncecount_hard> <bouncecount_unknown>0</bouncecount_unknown> <unsubscribecount>1</unsubscribecount> <newslettername>WarmEmailC</newslettername> <listname>'Preview List (Keep)'</listname> </item> </data> </response>
Unsuccessful Response:
<response> element
Field Name | Description |
status | Will return ERROR if unsuccessful |
errormessage | Text explaining why request failed |