Allows user to retrieve contact-level detail per open and click event for a specific campaign send.
JSON Request Example:
{
"username": "john.doe@xxxxx.com",
"usertoken": "abc123abc123abc123abc123abc123",
"requesttype": "Newsletters",
"requestmethod": "GetNewsletterContactDataSummary",
"details": {
"stat": "{*stat_id*}", /* required */
"startdate": "{*start_date*}",
"enddate": "{*end_date*}",
"pagination": { /* optional */
"limit": "{*max_records*}", /* required */
"next": "{*start_at_record_number*}" /* optional: default 0 */
}
}
}"json_request" element
| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | Newsletters |
| requestmethod | GetNewsletterContactDataSummary |
"details" element
| Field Name | Description |
| stat (required) | stat ID of campaign send to target |
"startdate" and "enddate" elements
| startdate (optional) | A start date for when subscribers were added in the YYYYMMDD format |
| enddate (optional) | An end date for when subscribers were added in the YYYYMMDD format |
NOTE: The actual timestamp used in the YYYYMMDD format is YYYY-MM-DD:00:00:00, or in other words, 12:00 am at 0 minutes and 0 seconds of the date given. Thus, if the user wished, for example, to specify a given date, such as January 1, 2025, they would use a startdate = 20250101 and an enddate of 20250102.
"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 contact data for specified stat ID successfully found and retrieved. |
Example of returned data:
Unsuccessful Response:
"response" element
| Field Name | Description |
| status | Will return FAILED if unsuccessful |
| errormessage | Text explaining why request failed |