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".
JSON Request Example:
"json_request" element
| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | Newsletters |
| requestmethod | GetNewsletterStats |
"details" element
| Field Name | Description |
| listid (Required) | List ID |
| startdate (optional) | only return stats for newsletters sent on or after this date |
| enddate (optional) | only return stats for newsletters sent on or before this date |
"pagination" element
Please note: If "pagination" parameters omitted, call will return as many records as allowable based on current application memory constraints.
| Field Name | Description |
| limit (optional but required if "next" parameter used) | max_records: Integer indicating maximum number of datasets (records) to be returned for the respective call. |
| next (optional) | start_at_record_number: If parameter used, the call response will be limited to the “limit” value and the response will include a pagination section with the appropriate “next” value to return the next sequential chunk of records, or “0” if all records have been returned. |
Successful Response:
"response" element
| Field Name | Description |
| status | Will return SUCCESS if newsletter(s) stats are successfully retrieved. |
"response" "data" "item" element (primary elements)
| Field Name | Description |
| statid | Statistical report ID for this newsletter |
| starttime | Start time of send in UNIX time format |
| finishtime | End time of send in UNIX time format |
| sendsize | Number of contacts newsletter was sent to |
| bouncecount_soft | Number of reported soft bounces |
| bouncecount_hard | Number of reported hard bounces |
| bouncecount_unknown | Number of reported unknown bounces |
| unsubscribecount | Number of unsubscribes |
| emailopens | Number of opens |
| linkclicks | Number of link clicks |
| emailforwards | Number of email forwards |
| subject | Subject of newsletter |
| newslettername | Name of newsletter |
| listname | List name contact population belongs to |
Unsuccessful Response:
"response" element
| Field Name | Description |
| status | Will return FAILED if unsuccessful |
| errormessage | Text explaining why request failed |