We know that you want to do some fancy pivot tables with your response data, so we’ve provided quite a few endpoints here to give you access to that response data. You can get overview numbers for all of your mailings and also drill down into finding out the actual members who opened a particular mailing.
Get the response summary for an account.
This method will return a month-based time series of data including sends, opens, clicks, mailings, forwards, and opt-outs. Test mailings and forwards are not included in the data returned.
A list of objects with each object representing one month. Each object contains:
Parameters: |
|
---|
Get the response summary for a particular mailing.
This method will return the counts of each type of response activity for a particular mailing.
Raises: | Http404 if the mailing does not exist. |
---|---|
Raises: | Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings. |
Get the list of messages that have been sent to an MTA for delivery.
An array of objects with the following fields:
Raises: | Http404 if the mailing does not exist. |
---|---|
Raises: | Http404if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings. |
Get the list of messages that are in the queue, possibly sent, but not yet delivered.
An array of objects with the following fields:
Raises: | Http404 if the mailing does not exist. |
---|---|
Raises: | Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings. |
Get the list of messages that have finished delivery.
This will include those that were successfully delivered, as well as those that failed due to hard or soft bounces.
This list can be limited by delivery_type.
Parameters: |
|
---|
An array of objects with the following fields:
Raises: | Http404 if the mailing does not exist. |
---|---|
Raises: | Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings. |
Get the list of opened messages for this campaign.
An array of objects with the following fields:
Raises: | Http404 if the mailing does not exist. |
---|---|
Raises: | Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings. |
Determine if the specified member opened the mailing.
True or False depending on if the member opened the specified mailing
Get the list of links for this mailing.
An array of objects with the following fields:
Raises: | Http404 if the mailing does not exist. |
---|---|
Raises: | Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings. |
Get the list of clicks for this mailing.
This list can also be limited by member_id or link_id.
Parameters: |
|
---|
An array of objects with the following fields:
Raises: | Http404 if the mailing does not exist. |
---|---|
Raises: | Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings. |
Get the list of clicks for this mailing for the specified member.
An array of objects with the following fields:
Raises: | Http404 if the mailing does not exist. |
---|---|
Raises: | Http404 if the mailing is not valid |
Get the list of forwards for this mailing.
An array of objects with the following fields:
Raises: | Http404 if the mailing does not exist. |
---|---|
Raises: | Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings. |
Get the list of optouts for this mailing.
An array of objects with the following fields:
Raises: | Http404 if the mailing does not exist. |
---|---|
Raises: | Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings. |
Get the list of signups for this mailing.
An array of objects with the following fields:
Raises: | Http404 if the mailing does not exist. |
---|---|
Raises: | Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings. |
Get the list of shares for this mailing
An array of objects with the following fields:
Raises: | Http404 if the mailing does not exist. |
---|---|
Raises: | Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings. |
Get the list of customer shares for this mailing
An array of objects with the following fields:
Raises: | Http404 if the mailing does not exist. |
---|---|
Raises: | Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings. |
Get the list of customer share clicks for this mailing
An array of objects with the following fields:
Raises: | Http404 if the mailing does not exist. |
---|---|
Raises: | Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings. |
Get the customer share associated with the share id.
An object with the following fields:
Raises: | Http404 if the mailing does not exist. |
---|---|
Raises: | Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings. |
Update a customer share status.
Parameters: |
|
---|
The updated status of the customer share.
Raises: | Http404 if the customer share does not exist. |
---|---|
Raises: | Http404 if the mailing does not exist |
Get overview of shares pertaining to this mailing_id.
An array of objects with the following fields:
Raises: | Http404 if the mailing does not exist. |
---|---|
Raises: | Http404 if the mailing is not valid |
Get information about the split test for the given parent mailing_id.
An object with the following attributes:
Raises: | Http404 if the mailing does not exist. |
---|---|
Raises: | Http404 if the mailing is not a split_test parent mailing |