This page provides you with information about how to get email statistics by message and by the recipient.
Info | ||
---|---|---|
| ||
Email Statistics use a different "base URL" than methods that can be used to manage your console account resources. Caller application should handle three distinct base URL bases URLs when working with REST API ("Console", "Statistics" and "Public") Use The use of paging for email statistics is often enabled by default. It is strongly recommended to avoid removal of default paging because in some cases the size of returned data could be really big (i.e. caller applications may experience either response time times that are is longer than expected or errors that are related to maximum data size restrictions on the infrastructure that hosts the caller). By implementing paging, a developer is able to can test the caller application in its edge cases, in such a way that even a huge number of opens, delivered emails, or clicks do not represent a problem. Filtering does not apply to the Count parameter |
On this page:
...
This section enables you to get statistics of an email message by specifying its ID. You can get message IDs by using using the List Messages method. For each type of statistics by message, both a "COUNT" method (only the total number) and a "LIST" method (all available details) are provided.
If you reuse a specified message and organize more campaigns with it, you should be aware that the message statistics of a specific campaign cannot be handled separately from the statistics of the other campaigns made with the same message. If you need to separate the statistics of each campaign, it is recommended that you clone the message (i.e. make a copy) whenever you are planning a new campaign.
...
Description | Get recipients to whom the specified message was sent | ||||
---|---|---|---|---|---|
HTTP Method | GET | ||||
URL | Get recipients to whom the specified message was sent (COUNT)
Get a list of email addresses addresses to whom 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 returns the number of sent messages (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.
|
...
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 returns 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.
|
...
Description | Get distribution of clicks for the specified message | ||||||||
---|---|---|---|---|---|---|---|---|---|
HTTP Method | GET | ||||||||
URL | Count the number of clicks on each link of the specified message
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) | UrlClicks returns a paged list of message links with at least one click. For each link, both the URL and the number of clicks are provided
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 returns 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 extracting either the number or the full list of the recipients whose unsubscription is related to a specified message.
Description | Get recipients whose unsubscription is related to the specified message | ||||
---|---|---|---|---|---|
HTTP Method | GET | ||||
URL | Get the number of unsubscribed (COUNT)
Get a detailed list of unsubscribed (LIST, paging is set as default with pageSize=20).
| ||||
JSON request (example) | none | ||||
JSON response (example) | COUNT method simply return returns the number of unsubscribed recipients (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.
|
...
This section enables you to get statistics related to a recipient by specifying its ID. You can get the recipient ID by using the "Check if a subscriber exists" method. For each type of statistics by message, both a "COUNT" method (only the total number) and a "LIST" method (all available details) are provided.
...
Description | Get the email messages sent to the specified recipient | ||||
---|---|---|---|---|---|
HTTP Method | GET | ||||
URL | Get the email messages sent to the specified recipient (COUNT)
Get the email messages sent to the specified recipient (LIST, paging is set as default with pageSize=20)
| ||||
JSON request (example) | none | ||||
JSON response (example) | COUNT method simply return returns 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 retrieve 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 the 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 recipient | ||||
---|---|---|---|---|---|
HTTP Method | GET | ||||
URL | Get the number of opens for the specified recipient (COUNT)
Get a list of messages that were opened by the specified recipient (LIST, paging is set as default with pageSize=20)
| ||||
JSON request (example) | none | ||||
JSON response (example) | COUNT method simply return returns the number of opens (e.g. 13) LIST method returns a detailed list of opened messages (each message could have been opened the message more than once by the same recipient, 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 retrieve 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 retrieve only the messages that have been opened more than once by a specified recipient you can specify the "FilterBy" option (e.g. Count >=2) |
Read clicks by the recipient
Full details about clicks are kept for at least 90 days, this period is longer if your console account has activated the "Detailed Statistics Extension" option.
Description | Get clicks performed by the specified recipient | ||||
---|---|---|---|---|---|
HTTP Method | GET | ||||
URL | Get the number of clicks for the specified message (COUNT)
Get a list of messages in which the specified recipients has have performed at least one click (LIST, paging is set as default with pageSize=20)
| ||||
JSON request (example) | none | ||||
JSON response (example) | COUNT method simply return returns the number of clicks (e.g. 13) LIST method returns a list of clicked messages (the specified recipient could have clicked the message more than once, see "Count" parameter for each message). 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 the distribution of clicks done by the specified recipient | ||||
---|---|---|---|---|---|
HTTP Method | GET | ||||
URL | Get a list of links, grouped by message, that the specified recipient has clicked (LIST, paging is set as default with pageSize=20). For each link, a click counter is provided.
| ||||
JSON request (example) | none | ||||
JSON response (example) | ClicksDetails returns a paged list of message links with at least one click. For each message both the clicked URL and the number of clicks are provided. 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.
|
Read bounces by the recipient
Description | Get bounces that have been reported for the specified recipient | ||||||||
---|---|---|---|---|---|---|---|---|---|
HTTP Method | GET | ||||||||
URL | Get the number of bounces related to the specified recipient (COUNT)
Get a list of messages in which a bounce condition occurred for a specified recipient (LIST, paging is set as default with pageSize=20)
Get a detailed list of messages in which a bounce condition occurred for a specified recipient (DETAILED LIST, paging is set as default with pageSize=20)
| ||||||||
JSON request (example) | none | ||||||||
JSON response (example) | COUNT method simply return returns the number of bounces (e.g. 4) LIST method returns a paged list
DETAILED LIST method returns a paged list that includes also the message details (subject and notes)
| ||||||||
Paging and filtering (example) | If you want to change the paging size you can take advantage of the "PageSize" option.
|
Read clicks on unsubscription link by the recipient
This feature allows to extract extracting either the unsubscriptions made by a specified recipient
Description | Get information about the unsubscriptions by the specified recipient | ||||
---|---|---|---|---|---|
HTTP Method | GET | ||||
URL | Get the number of clicks on any an "Unsubscribe" link by the specified recipient (COUNT)
Get a detailed list of clicks on the "Unsubscribe" link by the specified recipient (LIST, paging is set as default with pageSize=20).
| ||||
JSON request (example) | none | ||||
JSON response (example) | COUNT method simply return returns the number of recipients who clicked on Unsubsribe Unsubscribe link (e.g. 1) 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.
|
...
MailUp also provides some public pages that display some of the available statistics. These pages do not provide all the details you can obtain by properly combining the methods listed above, but in some cases, it could be an acceptable tradeoff. (Note: you may also use the returned URL to extract the account URL)
...