Allows user to retrieve contact-level detail per open and click event for a specific campaign send using an asynchronous process. This asynchronous call would be appropriate to use when the user is targeting a larger dataset. The call allows the user to decide whether to receive notification the call is complete and the associated JSON payload either via email or webhook.
JSON Request Example:
{
"username": "john.doe@xxxxx.com",
"usertoken": "abc123abc123abc123abc123abc123",
"requesttype": "Newsletters",
"requestmethod": "GetNewsletterContactDataSummaryAsync",
"details": {
"stat": "{*stat_id*}", /* required */
"startdate": "{*start_date*}",
"enddate": "{*end_date*}",
"notify": { /* required */
"type": "{*notification_type*}", /* required: email or webhook */
"value": "{*notification_target*}" /* required: email-address or webhook-url */
}
}
}"json_request" element
| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | Newsletters |
| requestmethod | GetNewsletterContactDataSummaryAsync |
"details" element
| Field Name | Description |
| stat (required) | stat ID of campaign send to target |
"startdate" and "enddate" elements
| startdate (optional) | A start date for parsing out a time interval in the YYYYMMDD format |
| enddate (optional) | An end date for parsing out a time interval 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.
"notify" element
| type (required) | Method by which user wishes to be notified when the call has completed processing and how the link to the JSON file will be accessed: either "email" or "webhook" |
| value (required) | If user selects notification via email, they must provide a valid email address which will receive the email notification. If user selects notification via webhook, they must provide a valid webhook URL to receive the payload, including the link to the JSON file. |
Successful Response:
"response" element
| Field Name | Description |
| status | Will return SUCCESS if call was successfully completed. |
| data | The job ID of the call processing |
Example of user notification:
(Where user has selected "email-address" as notification method and provided an email address):
(Where user has selected "webhook-url" as notification method and provided a webhook URL):
Unsuccessful Response:
"response" element
| Field Name | Description |
| status | Will return ERROR if unsuccessful |
| errormessage | Text explaining why request failed |