Get detailed statistics for a single campaign. 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"?>
<xmlrequest>
<username>JohnDoe</username>
<usertoken>abc123abc123abc123abc123</usertoken>
<requesttype>Newsletters</requesttype>
<requestmethod>GetNewsletterSummary</requestmethod>
<details>
<statid>7</statid> <!-- required -->
<summaryonly>1</summaryonly>
<resultlimit></resultlimit>
</details>
</xmlrequest><xmlrequest> element
| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | Newsletters |
| requestmethod | GetNewsletterSummary |
<details> element
| Field Name | Description |
| statid (Required) | Campaign statistics ID. To find this value, hover over "View" link for that campaign under "Email Campaign Statistics". |
| summaryonly | 1, yes or true for summary statistics; 0, no or false for detailed statistics |
| resultlimit (required) | Specifies the maximum number of results returned. Currently must enter a value: 0 to n. |
Successful Response:
<response> element
| Field Name | Description |
| status | Will return SUCCESS if newsletter stats successfully retrieved |
| data | See example below |
Sample Response:
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>SUCCESS</status>
<data>
<statid>7</statid>
<queueid>7</queueid>
<jobid>119</jobid>
<starttime>1295589722</starttime>
<finishtime>1295589722</finishtime>
<htmlrecipients>0</htmlrecipients>
<textrecipients>0</textrecipients>
<multipartrecipients>1</multipartrecipients>
<trackopens>1</trackopens>
<tracklinks>1</tracklinks>
<bouncecount_soft>0</bouncecount_soft>
<bouncecount_hard>0</bouncecount_hard>
<bouncecount_unknown>0</bouncecount_unknown>
<unsubscribecount>0</unsubscribecount>
<newsletterid>4</newsletterid>
<sendfromname>Bob Smallwood</sendfromname>
<sendfromemail>bob@test.com</sendfromemail>
<bounceemail>bounce@test.com</bounceemail>
<replytoemail>bob@test.com</replytoemail>
<charset>UTF-8</charset>
<sendinformation>a:4:{s:9:"Confirmed";i:1;s:12:"CustomFields";a:0:{}s:4:"List";a:1:{i:0;s:1:"2";}s:6:"Status";s:1:"a";}</sendinformation>
<sendsize>1</sendsize>
<sentby>2</sentby>
<notifyowner>1</notifyowner>
<linkclicks>3</linkclicks>
<emailopens>7</emailopens>
<emailforwards>0</emailforwards>
<emailopens_unique>1</emailopens_unique>
<htmlopens>7</htmlopens>
<htmlopens_unique>1</htmlopens_unique>
<textopens>0</textopens>
<textopens_unique>0</textopens_unique>
<hiddenby>0</hiddenby>
<sendtestmode>0</sendtestmode>
<sendtype>newsletter</sendtype>
<newslettername>WarmEmailC</newslettername>
<newslettersubject>%%JobRequest.OccupationSubject%% job in %%JobRe-quest.City%%</newslettersubject>
<username>test_account</username>
<fullname>Bob Smallwood</fullname>
<emailaddress>bob@test.com</emailaddress>
<lists>
<item>Preview List (Keep)</item>
</lists>
</data>
</response>
Unsuccessful Response:
<response> element
| Field Name | Description |
| status | Will return FAILED if unsuccessful |
| errormessage | Text explaining why request failed |