Page Comparison

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

...

Description

Get the email messages received by the specified recipient

HTTP Method

GET

URL

Get the email messages received by the specified recipient (COUNT)

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

Get the email messages received 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/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 recipient

HTTP Method

GET

URL

Get the number of opens for the specified recipient (COUNT)

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

Get a list of messages that were opened 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/Views

JSON request (example)

none

JSON response (example)

COUNT method simply return 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

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.

/Recipient/300501/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)

...

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.

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

JSON request (example)

none

JSON response (example)

UrlClicksDetails 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

Expand

Code Block

{"IsPaginated":false,"Items":[{"Count":1,"IdList":87,"IdMessage":11658,"Notes":"List Plus by Mike Brown","Subject":"Higlhights New Media 2014 Feb 10th ","UrlClicks":[{"Count":1,"IdMessage":11658,"Url":"Preference Center"}]},{"Count":1,"IdList":87,"IdMessage":11090,"Notes":"List Plus by Mike Brown","Subject":"Higlhights New Media 2013 July 3rd","UrlClicks":[{"Count":1,"IdMessage":11090,"Url":"Preference Center"}]},{"Count":2,"IdList":80,"IdMessage":10598,"Notes":" internal email","Subject":"Company Events","UrlClicks":[{"Count":2,"IdMessage":10598,"Url":"http:\/\/cremonapalacehotel.it\/"}]},{"Count":1,"IdList":51,"IdMessage":11575,"Notes":" Xmas newsletter","Subject":"[name], get your XMas coupon","UrlClicks":[{"Count":1,"IdMessage":11575,"Url":"http:\/\/www.xmascoupon2.com\/"}]},{"Count":1,"IdList":51,"IdMessage":11554,"Notes":"","Subject":"☑ Get your free trial account","UrlClicks":[{"Count":1,"IdMessage":11554,"Url":"http:\/\/attendee.gotowebinar.com\/register\/8702471"}]},{"Count":1,"IdList":51,"IdMessage":11531,"Notes":"A+B","Subject":"♛ Learn the golden rules","UrlClicks":[{"Count":1,"IdMessage":11531,"Url":"http:\/\/www.example.com\/ebooks_conferma\/sms-marketing.asp?email=cigoli@nweb.it"}]},{"Count":1,"IdList":51,"IdMessage":11442,"Notes":"","Subject":"Market watch","UrlClicks":[{"Count":1,"IdMessage":11442,"Url":"http:\/\/www.example.com\/ebooks_conferma\/osservatorio-mailup-2013.asp"}]},{"Count":1,"IdList":51,"IdMessage":11380,"Notes":"not customers: version A","Subject":"Market watch","UrlClicks":[{"Count":1,"IdMessage":11380,"Url":"http:\/\/www.example.com\/ebooks\/marketwatch2013.asp"}]},{"Count":1,"IdList":51,"IdMessage":11288,"Notes":"not customers, with embedded images","Subject":"Market watch","UrlClicks":[{"Count":1,"IdMessage":11288,"Url":"http:\/\/www.example.com\/email-marketing-ebooks\/html-email-marketing.asp?email=mike@example.com&code=12345"}]},{"Count":1,"IdList":51,"IdMessage":10970,"Notes":"","Subject":"Email and smartphones","UrlClicks":[{"Count":1,"IdMessage":10970,"Url":"http:\/\/www.example.com\/email-marketing-ebooks\/mobile-email-marketing.asp"}]},{"Count":2,"IdList":51,"IdMessage":10634,"Notes":"","Subject":"Inbox","UrlClicks":[{"Count":1,"IdMessage":10634,"Url":"http:\/\/www.example.com\/email-marketing-ebooks\/delivery.asp"},{"Count":1,"IdMessage":10634,"Url":"Lettura nel browser web"}]},{"Count":2,"IdList":51,"IdMessage":953,"Notes":"Invitation","Subject":"Invite for marketing forum 2010 in Milan","UrlClicks":[{"Count":2,"IdMessage":953,"Url":"http:\/\/www.mktforum2010.it\/"}]},{"Count":1,"IdList":41,"IdMessage":10621,"Notes":"","Subject":"Get your Christmas Box","UrlClicks":[{"Count":1,"IdMessage":10621,"Url":"Lettura nel browser web"}]},{"Count":1,"IdList":41,"IdMessage":10417,"Notes":"selected customers","Subject":"Try the new features of XYZ product","UrlClicks":[{"Count":1,"IdMessage":10417,"Url":"Form autoprofilazione: 54"}]},{"Count":1,"IdList":1,"IdMessage":11566,"Notes":"","Subject":"Email Check-Up","UrlClicks":[{"Count":1,"IdMessage":11566,"Url":"http:\/\/blog.example.com\/2013\/12\/choose-the-right-header\/"}]},{"Count":1,"IdList":1,"IdMessage":11497,"Notes":"","Subject":"Follow our webinars!","UrlClicks":[{"Count":1,"IdMessage":11497,"Url":"http:\/\/www.example.com\/new-features-2013.htm"}]},{"Count":1,"IdList":1,"IdMessage":11142,"Notes":"","Subject":"Improve your delivery rate","UrlClicks":[{"Count":1,"IdMessage":11142,"Url":"http:\/\/blog.example.com\/2013\/07\/email-check-up\/"}]},{"Count":3,"IdList":1,"IdMessage":10961,"Notes":" ","Subject":"Email and smartphones","UrlClicks":[{"Count":2,"IdMessage":10961,"Url":"http:\/\/blog.example.com\/2013\/05\/brcomr-industry-partner\/"},{"Count":1,"IdMessage":10961,"Url":"http:\/\/blog.example.com\/2013\/05\/mobile"}]},{"Count":1,"IdList":1,"IdMessage":10820,"Notes":"","Subject":"Important update","UrlClicks":[{"Count":1,"IdMessage":10820,"Url":"http:\/\/blog.example.com\/2013\/03\/product-management"}]},{"Count":1,"IdList":1,"IdMessage":10624,"Notes":"","Subject":"Check out the new plugin","UrlClicks":[{"Count":1,"IdMessage":10624,"Url":"http:\/\/blog.example.com\/2012\/12\/plugin-updates\/"}]}],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":20}

Paging and filtering (example)

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

/Recipient/300501/List/ClicksDetails?PageSize=5&PageNumber=1 (change page size to 5 and retreive the second page)

...

Versions Compared

Old Version 15

New Version 16

Key

Read opens by recipient