Allows user to retrieve basic info such as campaign name, ID, subject, send start time, send finish time and number of contacts campaign was sent to for all campaigns sent on behalf of the requesting account during a user-specified interval of time.
XML Request Example:
<?xml version="1.0" encoding="UTF-8"?>
<xmlrequest>
<username>JohnDoe</username>
<usertoken>abc123abc123abc123abc123</usertoken>
<requesttype>Newsletters</requesttype>
<requestmethod>GetNewslettersSent</requestmethod>
<details>
<intervalcount>60</intervalcount> <!-- required -->
<intervalunits>minutes</intervalunits> <!-- required -->
</details>
</xmlrequest>
xmlrequest> element
Field Name | Description |
username | Username used to login to Pinpointe |
usertoken | Unique token assigned to Pinpointe account |
requesttype | Newsletters |
requestmethod | GetNewslettersSent |
<details> element
Field Name | Description |
intervalcount (Required) | Some interval (must be a number) for the unit of time specified for <intervalunits>. For example, '12'. |
intervalunits (Required) | Can be:
|
Successful Response:
<response> element
Field Name | Description |
status | Will return SUCCESS if user was successfully added |
<response> <data> <item> element
Field Name | Description |
newsletterid | Campaign ID |
name | Campaign name |
subject | Campaign subject |
ownername | Campaign owner |
lastupdated | last time campaign was updated |
statid | Campaign stat ID if applicable |
starttime | The send start time for that campaign for that specific send |
finishtime | The send finish time for that campaign for that specific send |
sentto | Number of contacts campaign send to for that specific send |
Unsuccessful Response:
<response> element
Field Name | Description |
status | Will return FAILED if unsuccessful |
errormessage | Text explaining why request failed |