Returns statistics for newsletter asynchronously
JSON Request Example:
/** * Newsletters::GetNewsletterStatsAsync * * Return statistics for newsletters sent to a list * * listid [int, required]: selected list * startdate [date, optional]: only return stats for newsletters sent on or after this date * enddate [date, optional]: only return stats for newsletters sent on or before this date * format [string, optional, default json]: return data format, one of json, xml, csv * * notify [required] * type [string, required]: one of webhook, email * value [string, required]: webhook url or email address */ { "username": "joe", "usertoken": "abv", "requesttype": "Newsletters", "requestmethod": "GetNewsletterStatsAsync", "details": { "listid": "{*list-id*}", "startdate": "{*start date*}", "enddate": "{*end date*}", "format": "{*format: json|xml|csv*}", "notify": { "type": "{*type: webhook|email*}", "value": "{*webhook url or email address*}" } } }
"json_request" element
Field Name | Description |
username | Username used to login to Pinpointe |
usertoken | Unique token assigned to Pinpointe account |
requesttype | Newsletters |
requestmethod | GetNewsletterStatsAsync |
"details" element
listid (required) | Listid for the newsletter |
startdate (optional) | Return stats for newsletters sent on or after this date |
enddate (optional) | Return stats for newsletters sent on or before this date |
format optional | What format the statistics are delivered in (json, xml, csv); default is json. |
notify (required) | Notification method for newsletters. Type (webhook, email) Value (webhook URL, email address) |
Successful Response:
"response" element
Field Name | Description |
status | Will return SUCCESS if call was successful |
data | Jobid, time elapsed, and timestamp |
Unsuccessful Response:
"response" element
Field Name | Description |
status | Will return FAILED if unsuccessful |
errormessage | Reason for error message |