This page provides you with information about how to get email statistics by message and 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" optionthe period of data retention set for the console.
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 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.
|
...
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.the period of data retention set for the console
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.
|
...
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.the period of data retention set for the console
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 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 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 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
...
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 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 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 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) |
...