Page Comparison

This page provides you information about how to get email statistics by message and by recipient.

...

Description

Get recipients that received the specified message

HTTP Method

GET

URL

Get the number of recipients that received the specified message (COUNT)

Code Block
https://services.mailup.com/API/v1.1/Rest/MailStatisticsService.svc/Recipient/@id_Recipient/Count/Deliveries

Get a list of email addresses that received specified message (LIST, paging is set as default with pageSize=20)

Code Block
https://services.mailup.com/API/v1.1/Rest/MailStatisticsService.svc/Recipient/@id_Recipient/List/Deliveries

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)

Expand

Code Block

{"IsPaginated":false,"Items":[{"Count":1,"IdList":89,"IdMessage":11824,"Notes":"Martial Arts 02","Subject":"How to become a Ninja"},{"Count":1,"IdList":51,"IdMessage":11813,"Notes":"Martial Arts 01","Subject":"Karate fundamentals"}],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":2}

Paging and filtering (example)

If you want to change the paging size you can take advantage of the "PageSize" option.

/Recipient/1378914/List/Deliveries?PageSize=10&PageNumber=1 (change page size to 10 and retreive the second page)

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

/Recipient/1378914/List/Deliveries?filterby="IdList+%3d%3d+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)

Code Block
https://services.mailup.com/API/v1.1/Rest/MailStatisticsService.svc/Message/{ID_MESSAGE}/Count/Views

Get a list of recipients that opened the specified message (LIST, paging is set as default with pageSize=20)

Code Block
https://services.mailup.com/API/v1.1/Rest/MailStatisticsService.svc/Message/{ID_MESSAGE}/List/Views

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

Expand

Code Block

{"IsPaginated":true,"Items":[{"Count":1,"IdList":1,"IdMessage":11775,"Notes":"","Subject":"Join our webinar"},{"Count":1,"IdList":51,"IdMessage":11741,"Notes":"","Subject":"Check out our new ebook"},{"Count":1,"IdList":1,"IdMessage":11677,"Notes":"Message B","Subject":"Success Stories in digital marketing"},{"Count":2,"IdList":1,"IdMessage":11633,"Notes":"Message A","Subject":"Hello [name], here is a selection of success stories"},{"Count":2,"IdList":1,"IdMessage":11566,"Notes":"Message A","Subject":"Merry Christmas"},{"Count":2,"IdList":51,"IdMessage":11564,"Notes":"Message B","Subject":"[name], get your XMas present!"},{"Count":3,"IdList":51,"IdMessage":11536,"Notes":"","Subject":"Email and Business"},{"Count":4,"IdList":1,"IdMessage":11497,"Notes":"","Subject":"Learn more about SMS"},{"Count":1,"IdList":1,"IdMessage":11406,"Notes":"","Subject":"April Newsletter"},{"Count":3,"IdList":1,"IdMessage":11313,"Notes":"","Subject":"Happy Birthday"},{"Count":1,"IdList":51,"IdMessage":11217,"Notes":"","Subject":"Quick Poll"},{"Count":2,"IdList":1,"IdMessage":11142,"Notes":"","Subject":"How to improve your business"},{"Count":4,"IdList":51,"IdMessage":11091,"Notes":"","Subject":"Product News - May 2013"},{"Count":1,"IdList":1,"IdMessage":11049,"Notes":"","Subject":"Price changes"},{"Count":4,"IdList":51,"IdMessage":11005,"Notes":"","Subject":"[name], join us at XYZ conference"},{"Count":3,"IdList":51,"IdMessage":10970,"Notes":"Message B","Subject":"Email and smartphones"},{"Count":12,"IdList":1,"IdMessage":10961,"Notes":"Message A","Subject":"Email and smartphones"},{"Count":1,"IdList":51,"IdMessage":10949,"Notes":"","Subject":"How to make a good marketing plan"},{"Count":1,"IdList":1,"IdMessage":10838,"Notes":"","Subject":"[name], subscribe our promotions newsletter!"},{"Count":1,"IdList":1,"IdMessage":10820,"Notes":"","Subject":"Product News - March 2013"}],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":37}

Paging and filtering (example)

If you want to change the paging size you can take advantage of the "PageSize" option.

/Message/11826/List/Views?PageSize=5&PageNumber=1 (change page size to 5 and retreive the second page)

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)

/Recipient/300501/List/Views?filterby="IdList+%3d%3d+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)

/Recipient/300501/List/Views?filterby="Count+%3e%3d+2" ??????????????????????

Read clicks by 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.

...

COUNT method simply return the number of

Description

Get bounces that have been reported for the specified recipient

HTTP Method

GET

URL

JSON response (example)

Get the number of bounces related to the specified recipient (COUNT)

Code Block
https://services.mailup.com/API/v1.1/Rest/MailStatisticsService.svc/Recipient/@id_Recipient/Count/Bounces

Get a list of messages in which a bounce condition occurred for specified recipient (LIST, paging is set as default with pageSize=20)

Code Block
https://services.mailup.com/API/v1.1/Rest/MailStatisticsService.svc/Recipient/@id_Recipient/List/Bounces

JSON request (example)

none

Get a detailed list of messages in which a bounce condition occurred for specified recipient (DETAILED LIST, paging is set as default with pageSize=20)

Code Block
https://services.mailup.com/API/v1.1/Rest/MailStatisticsService.svc/Recipient/@id_Recipient/List/BounceDetails

JSON request (example)

none

JSON response (example)

COUNT method simply return the number of bounces (e.g. 4)

LIST method returns a paged list

Expand

Code Block

{"IsPaginated":false,"Items":[{"Email":"monica@example.com","IdMessage":11824,"IdRecipient":1419659,"Type":"MBSD "},{"Email":"monica@example.com","IdMessage":11813,"IdRecipient":1419659,"Type":"MBSD "},{"Email":"monica@example.com","IdMessage":11775,"IdRecipient":1419659,"Type":"MBSD "},{"Email":"monica@example.com","IdMessage":11766,"IdRecipient":1419659,"Type":"MBSD "}],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":4}

Paging and filtering (example)

If you want to change the paging size you can take advantage of the "PageSize" option.

/Recipient/1419659/List/Bounces?PageSize=10&PageNumber=1 (change page size to 10 and retreive the second page)

Read clicks on unsubscription link by recipient

This feature allows to extract either the number of clicks on "Unsubscribe" link or the full list of recipients that clicked on it.

Note

There are also other unsubscription sources (e.g. import, bounces, admin console...), if you want to extract a list of all the recipients that were unsubscribed due to any reason you should refer to "Read Unsubscribed"
A click un "Unsubscribe" link may be not enough to say that recipient is unsubscribed (e.g. the MailUp list to which the message belongs may be configured with a confirmed opt-out and recipient may not have clicked the link on the confirmation page)

{"IsPaginated":true,"Items":[{"Email":"manuel.f@example.com","IdMessage":11775,"IdRecipient":1419828},{"Email":"manuel.f@example.com","IdMessage":11775,"IdRecipient":1419828},{"Email":"manuel.f@example.com","IdMessage":11775,"IdRecipient":1419828},{"Email":"agency@example.com","IdMessage":11775,"IdRecipient":1419668},{"Email":"agency@example.com","IdMessage":11775,"IdRecipient":1419668

DETAILED LIST method returns a paged list that includes also the message details (subject and notes)

Description

Get recipients whose unsubscription is related to the specified message

HTTP Method

GET

URL

Get the number of clicks on "Unsubscribe" link of the specified message (COUNT)

Code Block
https://services.mailup.com/API/v1.1/Rest/MailStatisticsService.svc/Message/{ID_MESSAGE}/Count/Unsubscriptions

Get a detailed list of clicks on "Unsubscribe" link of the specified message (LIST, paging is set as default with pageSize=20).

Code Block
https://services.mailup.com/API/v1.1/Rest/MailStatisticsService.svc/Message/{ID_MESSAGE}/List/Unsubscriptions

JSON request (example)

none

JSON response (example)

COUNT method simply return the number of recipients who clicked on Unsubsribe link (e.g. 103)

LIST method returns a paged list (Note: if a recipient clicks three times on "Unsubscribed" links this result contains three items for that recipient)

Expand

Code Block

Expand

Code Block

{"IsPaginated":false,"Items":[{"Email":"monica@example.com","IdMessage":11824,"IdRecipient":1419659,"Notes":"Martial Arts 02","Subject":"How to become a Ninjia","Type":"MBSD "},{"Email":"monica@example.com","IdMessage":11813,"IdRecipient":1419659,"Notes":"Martial Arts 01","Subject":"Karate fundamentals","Type":"MBSD "},{"Email":"barbie@examplemonica@example.com","IdMessage":11775,"IdRecipient":1419568}1419659,{"EmailNotes":"barbie@example.com","IdMessageSubject":11775"Join our webinar","IdRecipientType":1419568"MBSD "},{"Email":"matt@examplemonica@example.com","IdMessage":1177511766,"IdRecipient":1419482}1419659,{"EmailNotes":"matt@example.com","IdMessageSubject":11775,"IdRecipient":1419482},{"Email"Mastering Kung Fu","Type":"matt@example.com"MBSD "}],"IdMessagePageNumber":117750,"IdRecipientPageSize":1419482}20,{"Email":"peter@example.com","IdMessage"Skipped":117750,"IdRecipientTotalElementsCount":1419246},{"Email":"peter@example.com","IdMessage":11775,"IdRecipient":1419246},{"Email":"peter@example.com","IdMessage":11775,"IdRecipient":1419246},{"Email":"luca@example.com","IdMessage":11775,"IdRecipient":1419184},{"Email":"luca@example.com","IdMessage":11775,"IdRecipient":1419184},{"Email":"info@example.com","IdMessage":11775,"IdRecipient":1419095},{"Email":"info@example.com","IdMessage":11775,"IdRecipient":1419095},{"Email":"info@example.com","IdMessage":11775,"IdRecipient":1419095},{"Email":"sales@example.com"4}

Paging and filtering (example)

If you want to change the paging size you can take advantage of the "PageSize" option.

/Recipient/1419659/List/Bounces?PageSize=10&PageNumber=1 (change page size to 10 and retreive the second page)

Read clicks on unsubscription link by recipient

This feature allows to extract either the number of clicks on "Unsubscribe" link or the full list of recipients that clicked on it.

Note

There are also other unsubscription sources (e.g. import, bounces, admin console...), if you want to extract a list of all the recipients that were unsubscribed due to any reason you should refer to "Read Unsubscribed"
A click un "Unsubscribe" link may be not enough to say that recipient is unsubscribed (e.g. the MailUp list to which the message belongs may be configured with a confirmed opt-out and recipient may not have clicked the link on the confirmation page)

Description

Get information about clicks on "Unsubscribe" link by the specified recipient

HTTP Method

GET

URL

Get the number of clicks on any "Unsubscribe" link by the specified recipient (COUNT)

Code Block
https://services.mailup.com/API/v1.1/Rest/MailStatisticsService.svc/Recipient/@id_Recipient/Count/Unsubscriptions

Get a detailed list of clicks on "Unsubscribe" link by the specified recipient (LIST, paging is set as default with pageSize=20).

Code Block
https://services.mailup.com/API/v1.1/Rest/MailStatisticsService.svc/Recipient/@id_Recipient/List/Unsubscriptions

JSON request (example)

none

JSON response (example)

COUNT method simply return the number of recipients who clicked on Unsubsribe link (e.g. 1)

LIST method returns a paged list

Expand

In this example recipient unsubscribed by means of unsubscription link of message 11775 on list 1

Code Block

{"IsPaginated":false,"Items":[{"IdList":1,"IdMessage":11775,"IdRecipient":1418646},{"EmailNotes":"sales@example.com","IdMessageSubject":11775,"IdRecipient":1418646"Join our webinar"}],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":1791}

Paging and filtering (example)

If you want to change the paging size you can take advantage of the "PageSize" option.

/MessageRecipient/118261419828/List/Unsubscriptions?PageSize=10&PageNumber=1 (change page size to 10 and retreive the second page)

Versions Compared

Old Version 6

New Version 7

Key

Read opens by recipient

Read clicks by recipient

Read clicks on unsubscription link by recipient

Read clicks on unsubscription link by recipient