...
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 when working with REST API ("Console", "Statistics" and "Public") 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 that are 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 test the caller application in its edge cases, in such a way that even huge number of opens, delivered emails or clicks do not represent a problem. |
...
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, pagination 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. 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 message opens
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.
|
Read message clicks
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 for the specified message | ||||||
---|---|---|---|---|---|---|---|
HTTP Method | GET | ||||||
URL | Get the number of clicks for the specified message (COUNT)
| Paging and filtering (example) | 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.
|
Read details about clicked links
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 distribution of clicks for the specified message | ||||||||
---|---|---|---|---|---|---|---|---|---|
HTTP Method | GET | ||||||||
URL | Count the number of clicks on each link of 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.
|