This page provides you information about how to get email statistics by message and by recipient.
...
Read message recipients
Please note that the full list of message recipients are is kept inside MailUp only for 15 days after message sending, after that period COUNT returns zero and LIST returns an empty array.
...
Description | Get clicks for the specified message | ||||
---|---|---|---|---|---|
HTTP Method | GET | ||||
URL | Get the number of clicks for the specified message (COUNT)
Get a list of recipients that clicked at least a link in the specified message (LIST, paging is set as default with pageSize=20)
| ||||
JSON request (example) | none | ||||
JSON response (example) | COUNT method simply return the number of clicks (e.g. 13) LIST method returns a list of recipients that clicked in the message (each recipient could have clicked the message more than once, see "Count" parameter for each recipient). The list is paged by default if the number of returned items is higher than 20
| ||||
Paging and filtering (example) | If you want to change the paging size you can take advantage of the "PageSize" option.
|
...
Description | Get recipients for whom a bounce occurred when the specified message was sent | ||||
---|---|---|---|---|---|
HTTP Method | GET | ||||
URL | Get the number of bounces related to the specified message (COUNT)
Get a list of email addresses that originated a bounce when the specified message was sent (LIST, paging is set as default with pageSize=20)
| ||||
JSON request (example) | none | ||||
JSON response (example) | COUNT method simply return the number of bounces (e.g. 103) LIST method returns a paged list
| ||||
Paging and filtering (example) | If you want to change the paging size you can take advantage of the "PageSize" option.
|
Read
...
unsubscribed recipients by message
This feature allows to extract either the number or the full list of the recipients whose unsubscription is related to specified message.
...
Description | Get recipients that received the specified message | ||||
---|---|---|---|---|---|
HTTP Method | GET | ||||
URL | Get the number of recipients that received the specified message (COUNT)
Get a list of email addresses that received specified message (LIST, paging is set as default with pageSize=20)
| ||||
JSON request (example) | none | ||||
JSON response (example) | COUNT method simply return the number of delivered messages (e.g. 2) LIST method returns a paged list (default page size = 20)
| ||||
Paging and filtering (example) | If you want to change the paging size you can take advantage of the "PageSize" option.
If you want to retreive only the messages that are related to a particular list you can specify the "FilterBy" option (e.g. only messages that belong to list 51
|
Read opens by recipient
Full details about opens are kept for at least 90 days, this period is longer if your console account has activated the "Detailed Statistics Extension" option.
Description | Get opens for the specified message | ||||
---|---|---|---|---|---|
HTTP Method | GET | ||||
URL | Get the number of opens for the specified message (COUNT)
Get a list of recipients that opened the specified message (LIST, paging is set as default with pageSize=20)
| ||||
JSON request (example) | none | ||||
JSON response (example) | COUNT method simply return the number of opens (e.g. 13) LIST method returns a list of recipients that opened the message (each recipient could have opened the message more than once, see "Count" parameter for each recipient). The list is paged by default if the number of returned items is higher than 20
| ||||
Paging and filtering (example) | If you want to change the paging size you can take advantage of the "PageSize" option.
If you want to retreive only the messages that are related to a particular list you can specify the "FilterBy" option (e.g. only messages that belong to list 51)
If you want to retreive only the messages that have been opened more than once by specified recipient you can specify the "FilterBy" option (e.g. Count >=2) |
...