Get detailed statistics for a single campaign. Statistics include start and finish times; number of recipients and their preferred format; bounces and opens; links clicked; and others.
JSON Request Example:
{
"username": "bob",
"usertoken": "123",
"requesttype": "Stats",
"requestmethod": "GetNewsletterSummary",
"details": {
"stat": "{*stat_id*}", /* required */
"summaryonly": "{*summary_only_boolean*}",
"pagination": { /* optional: default return all at once */
"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 | Stats |
| requestmethod | GetNewsletterSummary |
Please note: ALL OPTIONAL elements that are not used should be deleted from submitted call. For example, if no IP address will be supplied as part of the call, "ipaddress": "{*ip_address*}", should be deleted.
"details" element
| Field Name | Description |
| statid (Required) | Campaign statistics ID. To find this value, hover over "View" link for that campaign under "Email Campaign Statistics". |
| summaryonly (optional) | 1, yes or true for summary statistics; 0, no or false for detailed statistics. |
"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 stats successfully retrieved |
| data | See example below |
Sample Response:
Unsuccessful Response:
"response" element
| Field Name | Description |
| status | Will return FAILED if unsuccessful |
| errormessage | Text explaining why request failed |