Allows user to retrieve the statistical report ID number of newsletters by searching based on the newsletter(s) name or part of a name.
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>GetNewsletterStatIds</requestmethod>
<details>
<!-- exactly one of name, startswith, endswith, contains is required -->
<name>saSa</name>
<startswith></startswith>
<endswith></endswith>
<contains></contains>
</details>
</xmlrequest><xmlrequest> element
| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | Newsletters |
| requestmethod | GetNewsletterStatIds |
<details> element
NOTE: The following fields are case sensitive.
| Field Name | Description |
| name | The full name of the newsletter |
| startswith | Provide one to 'n' starting characters of newsletter name |
| endswith | Provide one to 'n' ending characters of newsletter name |
| contains | Provide one to 'n' characters of newsletter name |
Successful Response:
<response> element
| Field Name | Description |
| status | Will return SUCCESS if newsletter stat id is successfully retrieved |
<response> <data> <item> element
| Field Name | Description |
| id | Newsletter ID |
| name | Newsletter name |
| statids | Statistical report ID(s) for this newsletter |
Unsuccessful Response:
<response> element
| Field Name | Description |
| status | Will return FAILED if unsuccessful |
| errormessage | Text explaining why request failed |