User can retrieve primary statistical metrics for autoresponders. This does not return contact-level statistics.
JSON Request Example:
/**
* Stats::GetAutoresponderResults
*
* Return summary statistics for autoresponders.
* Does not return contact-level statistics.
*
* autoresponderid [optional - int] -- selected autoresponder
* autorespondername [optional - string] -- selected autoresponder
* If both autoresponderid and autorespondername are given, only the first one found is used.
* If neither are given, all autoresponders are returned, subject to other selection criteria.
*
* grouping [optional - autoresponder, send; default autoresponder] -- aggregate stats by autoresponder/don't
* If grouping is 'autoresponder', the stats for all sends of a autoresponder are aggregated into a single record.
* If grouping is 'send', a separate summary stats record is returned for each individual send.
*
* pagination [optional]
* limit [required - int] -- maximum number of records to return
* next [optional - int] -- first record to return (default 0)
* If used, the response will be limited to 'limit' records
* 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.
*/
{
"username": "bob",
"usertoken": "abc",
"requesttype": "Stats",
"requestmethod": "GetAutoresponderResults",
"details": {
"autoresponderid": "{*autoresponder_id*}",
"autorespondername": "{*autoresponder_name*}",
"grouping": "{*string: autoresponder|send*}",
"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 | GetAutoResponderResults |
"details" element
| Field Name | Description |
| autoresponderid (Required if autoresponder name not provided) | Autoresponder ID |
| autorespondername (Required if autoresponderid not provided ) | Autoresponder name |
| grouping (optional) | How to group autoresponders; default is autoresponder; (autoresponder, send); send shows individual sends in a separate summary |
"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 autoresponder stats are successfully retrieved. |
"response" "data" "item" element (primary elements)
| Field Name | Description |
| count | Number of autoresponder emails sent |
| stats | Stats for autoresponder |
Unsuccessful Response:
"response" element
| Field Name | Description |
| status | Will return FAILED if unsuccessful |
| errormessage | Text explaining why request failed |