Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

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

Best Practices

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.

 

 

On this page:

 


Get Statistics by Message

This section enables you to get statistics of an email message by specifying its ID. You can get message IDs by using 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 perform more sendings with it you should be aware that message statistics of a specific sending cannot be handled separately from the statistics of the other sendings of the same message. If you need to separate the statistics of each sending it is recommended that you clone (i.e. make a copy of the message) whenever you are planning a new campaign.

Read message recipients

Please note that message recipients are kept inside MailUp only for 15 days, after that period COUNT returns zero and LIST returns an empty array.

Description

Get recipients that received the specified message

HTTP Method

GET

URL

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

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


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

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

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

 Click here to expand...
{"IsPaginated":true,"Items":[{"Email":"tim@example.com","IdMessage":11826,"IdRecipient":1405754},{"Email":"mary@example.com","IdMessage":11826,"IdRecipient":1403161},{"Email":"jack@example.com","IdMessage":11826,"IdRecipient":1392647},{"Email":"marta@example.com","IdMessage":11826,"IdRecipient":1390174},{"Email":"robert@example.com","IdMessage":11826,"IdRecipient":1389856},{"Email":"susan@example.com","IdMessage":11826,"IdRecipient":1386049},{"Email":"patrick@example.com","IdMessage":11826,"IdRecipient":1386048},{"Email":"markus@example.com","IdMessage":11826,"IdRecipient":1386047},{"Email":"bernardo@example.com","IdMessage":11826,"IdRecipient":1386046},{"Email":"cindy@example.com","IdMessage":11826,"IdRecipient":1385588},{"Email":"alexander@example.com","IdMessage":11826,"IdRecipient":1381517},{"Email":"naomi@example.com","IdMessage":11826,"IdRecipient":1377532},{"Email":"jimmy@example.com","IdMessage":11826,"IdRecipient":1377528},{"Email":"tony@networkweb.net","IdMessage":11826,"IdRecipient":1377527},{"Email":"larry@example.com","IdMessage":11826,"IdRecipient":1377520},{"Email":"pamela@example.com","IdMessage":11826,"IdRecipient":1377516},{"Email":"martin@example.com","IdMessage":11826,"IdRecipient":1377047},{"Email":"jenny@example.com","IdMessage":11826,"IdRecipient":1376721},{"Email":"george@example.com","IdMessage":11826,"IdRecipient":1376600},{"Email":"david@example.com","IdMessage":11826,"IdRecipient":374939}],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":54}

Paging and filtering (example)

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

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

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)

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)

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

 Click here to expand...
{"IsPaginated":false,"Items":[{"Count":1,"Email":"susan@example.com","IdMessage":11826,"IdRecipient":1386049},{"Count":1,"Email":"jimmy@example.com","IdMessage":11826,"IdRecipient":1377528},{"Count":4,"Email":"larry@example.com","IdMessage":11826,"IdRecipient":1377520},{"Count":1,"Email":"pedro@example.com","IdMessage":11826,"IdRecipient":319189},{"Count":1,"Email":"kevin@example.com","IdMessage":11826,"IdRecipient":316618},{"Count":1,"Email":"kris@example.com","IdMessage":11826,"IdRecipient":309309},{"Count":1,"Email":"barbie@example.com","IdMessage":11826,"IdRecipient":307408},{"Count":3,"Email":"ken@example.com","IdMessage":11826,"IdRecipient":303812}],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":8}

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)

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)

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

 

Get a list of recipients that clicked at least a link in the specified message (LIST, paging is set as default with pageSize=20)

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 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

 Click here to expand...
{"IsPaginated":true,"Items":[{"Count":1,"Email":"dottie@yahoo.it","IdRecipient":1419867},{"Count":1,"Email":"test@libero.it","IdRecipient":1419861},{"Count":2,"Email":"genny@example.com","IdRecipient":1419852},{"Count":2,"Email":"wayne@example.com","IdRecipient":1419829},{"Count":1,"Email":"manuel@example.com","IdRecipient":1419828},{"Count":3,"Email":"info1@example.com","IdRecipient":1419809},{"Count":2,"Email":"info2@example.com","IdRecipient":1419795},{"Count":1,"Email":"vladimir@example.com","IdRecipient":1419793},{"Count":2,"Email":"stefy@example.com","IdRecipient":1419687},{"Count":1,"Email":"sergio@example.com","IdRecipient":1419680},{"Count":2,"Email":"rocco@example.com","IdRecipient":1419673},{"Count":1,"Email":"sales1@example.com","IdRecipient":1419668},{"Count":1,"Email":"info3@example.com","IdRecipient":1419629},{"Count":2,"Email":"info4@example.com","IdRecipient":1419626},{"Count":2,"Email":"giorgia@example.com","IdRecipient":1419597},{"Count":1,"Email":"francis@example.com","IdRecipient":1419575},{"Count":1,"Email":"frank61@example.com","IdRecipient":1419568},{"Count":1,"Email":"anna@example.com","IdRecipient":1419561},{"Count":1,"Email":"adrian@example.com","IdRecipient":1419552},{"Count":1,"Email":"rita@example.com","IdRecipient":1419537}],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":947}

Paging and filtering (example)

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

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

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

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

 

Get a list of recipients that clicked at least a link in the specified message (LIST, paging is set as default with pageSize=20)

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

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

 Click here to expand...
{"IsPaginated":true,"Items":[{"Count":63,"IdMessage":11775,"Url":"Read in web browser"},{"Count":628,"IdMessage":11775,"Url":"http:\/\/www.example.com\/landing-page\/freetrial-12\/tryme30days.asp"},{"Count":283,"IdMessage":11775,"Url":"http:\/\/blog.example.com\/2014\/04\/update-machinery\/ "},{"Count":59,"IdMessage":11775,"Url":"http:\/\/www.example.com\/pec ipsettings.htm"},{"Count":123,"IdMessage":11775,"Url":"https:\/\/www.youtube.com\/watch?v=su896YA0gC3A&feature=youtu.be"},{"Count":86,"IdMessage":11775,"Url":"Unsubscribe"},{"Count":24,"IdMessage":11775,"Url":"http:\/\/www.example.com"},{"Count":68,"IdMessage":11775,"Url":"http:\/\/www.example.com\/email-checkup\/"},{"Count":5,"IdMessage":11775,"Url":"http:\/\/www.linkedin.com\/shareArticle?mini=true&url=http:\/\/e.acme.com\/frontend\/nl_preview_window.aspx?idNL=11775&fc=MTE4NzU=&&title=Read april newsletter from acme&summary=Read latest news from industry world"},{"Count":19,"IdMessage":11775,"Url":"Preference Center"},{"Count":12,"IdMessage":11775,"Url":"Autoprofile: 72"},{"Count":11,"IdMessage":11775,"Url":"http:\/\/www.facebook.com\/pages\/acme\/97291130649"},{"Count":4,"IdMessage":11775,"Url":"http:\/\/newsletter.mailupnet.it\/frontend\/track.aspx?url=http:\/\/www.example.com\/votenewsletter.asp?id=1"},{"Count":5,"IdMessage":11775,"Url":"http:\/\/www.example.com\/votenewsletter.asp"},{"Count":10,"IdMessage":11775,"Url":"http:\/\/www.example.com\/responsability.htm"},{"Count":3,"IdMessage":11775,"Url":"http:\/\/newsletter.mailupnet.it\/frontend\/track.aspx?url=http:\/\/www.example.com\/votenewsletter.asp?id=2"},{"Count":4,"IdMessage":11775,"Url":"http:\/\/twitter.com\/acme"},{"Count":4,"IdMessage":11775,"Url":"https:\/\/twitter.com\/intent\/tweet?source=webclient&text=I am reading april newsletter! via @acme http:\/\/e.acme.com\/frontend\/nl_preview_window.aspx?idNL=11775&fc=MTE3NzU=&"},{"Count":3,"IdMessage":11775,"Url":"http:\/\/newsletter.mailupnet.it\/frontend\/track.aspx?url=http:\/\/www.example.com\/votenewsletter.asp?id=4"},{"Count":8,"IdMessage":11775,"Url":"http:\/\/e.acme.com\/frontend\/newsletters.aspx?idlist=1&hashlista=6dfe152c-fbf2-420a-9e2d-51e462fea20d"}],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":27}

 

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

 Click here to expand...

For sake of simplicity we consider a message with only one clicked link and with the page size that is reduced to 2 items per page

{
	"IsPaginated":true,
	"Items":[{
		"Count":283,
		"IdMessage":11826,
		"RecipientsClicks":[{
			"Count":2,
			"Email":"vladimir@example.com",
			"IdRecipient":1419793
		},
		{
			"Count":3,
			"Email":"larry@example.com",
			"IdRecipient":1377520
		}
        ],
		"Url":""http:\/\/www.example.com\/responsability.htm""
	}],
	"PageNumber":0,
	"PageSize":2,
	"Skipped":0,
	"TotalElementsCount":300
}

Paging and filtering (example)

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

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

Read bounces by message

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)

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

 

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)

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

JSON request (example)

none

JSON response (example)

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

LIST method returns a paged list

 Click here to expand...

Disclaimer: provided addresses have been invented as examples of wrong emails, it is not guaranteed that they actually match with the bounce "Type" that is specified for each of them

{"IsPaginated":true,"Items":[{"Email":"monica@example.com","IdMessage":11775,"IdRecipient":1419659,"Type":"MBSD "},{"Email":"marco@nweb.it","IdMessage":11775,"IdRecipient":1419650,"Type":"SBDF "},{"Email":"max@yahoooo.it","IdMessage":11775,"IdRecipient":1419635,"Type":"HB "},{"Email":"infos@homail.com","IdMessage":11775,"IdRecipient":1419632,"Type":"HB "},{"Email":"info@wrongaddress.com","IdMessage":11775,"IdRecipient":1419616,"Type":"MBSD "},{"Email":"dan.marketing@hardbounce.com","IdMessage":11775,"IdRecipient":1419579,"Type":"HB "},{"Email":"alice@gmmail.it","IdMessage":11775,"IdRecipient":1419467,"Type":"MBSD "},{"Email":"fax@hotmeils.it","IdMessage":11775,"IdRecipient":1419068,"Type":"GB "},{"Email":"informationes@nweb.com","IdMessage":11775,"IdRecipient":1418795,"Type":"GB "},{"Email":"clas@gimail.com","IdMessage":11775,"IdRecipient":1415989,"Type":"GB"}],
"PageNumber":0,"PageSize":10,"Skipped":0,"TotalElementsCount":1174}

Paging and filtering (example)

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

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

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

 

  • 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 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)

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).

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)

 Click here to expand...
{"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},{"Email":"barbie@example.com","IdMessage":11775,"IdRecipient":1419568},{"Email":"barbie@example.com","IdMessage":11775,"IdRecipient":1419568},{"Email":"matt@example.com","IdMessage":11775,"IdRecipient":1419482},{"Email":"matt@example.com","IdMessage":11775,"IdRecipient":1419482},{"Email":"matt@example.com","IdMessage":11775,"IdRecipient":1419482},{"Email":"peter@example.com","IdMessage":11775,"IdRecipient":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","IdMessage":11775,"IdRecipient":1418646},{"Email":"sales@example.com","IdMessage":11775,"IdRecipient":1418646}],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":179}

Paging and filtering (example)

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

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

 


Get Statistics by Recipient

This section enables you to get statistics related to a recipient by specifying its ID. You can get recipient ID by using "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.

Read delivered messages by recipient

Please note that delivery details are kept inside MailUp only for 15 days, after that period COUNT returns zero and LIST returns an empty array.

Description

Get recipients that received the specified message

HTTP Method

GET

URL

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

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)

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)

 Click here to expand...
{"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)

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)

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

 Click here to expand...
{"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.

Description

Get clicks performed by the specified recipient

HTTP Method

GET

URL

Get the number of clicks for the specified message (COUNT)

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

 

Get a list messages in which the specified recipients has performed at least one click (LIST, paging is set as default with pageSize=20)

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

JSON request (example)

none

JSON response (example)

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

 Click here to expand...
{"IsPaginated":false,"Items":[{"Count":1,"IdList":87,"IdMessage":11658,"Notes":"List Plus by Mike Brown","Subject":"Higlhights New Media 2014 Feb 10th "},{"Count":1,"IdList":87,"IdMessage":11090,"Notes":"List Plus by Mike Brown","Subject":"Higlhights New Media 2013 July 3rd"},{"Count":2,"IdList":80,"IdMessage":10598,"Notes":" internal email","Subject":"Company Events"},{"Count":1,"IdList":51,"IdMessage":11575,"Notes":" Xmas newsletter","Subject":"[name], get your XMas coupon"},{"Count":1,"IdList":51,"IdMessage":11554,"Notes":"","Subject":"☑ Get your free trial account"},{"Count":1,"IdList":51,"IdMessage":11531,"Notes":"A+B","Subject":"♛ Learn the golden rules"},{"Count":1,"IdList":51,"IdMessage":11442,"Notes":"","Subject":"Market watch"},{"Count":1,"IdList":51,"IdMessage":11380,"Notes":"not customers: version A","Subject":"Market watch"},{"Count":1,"IdList":51,"IdMessage":11288,"Notes":"not customers, with embedded images","Subject":"Market watch"},{"Count":1,"IdList":51,"IdMessage":10970,"Notes":"","Subject":"Email and smartphones"},{"Count":2,"IdList":51,"IdMessage":10634,"Notes":"","Subject":"Inbox"},{"Count":2,"IdList":51,"IdMessage":953,"Notes":"Invitation","Subject":"Invite for marketing forum 2010 in Milan"},{"Count":1,"IdList":41,"IdMessage":10621,"Notes":"","Subject":"Get your Christmas Box"},{"Count":1,"IdList":41,"IdMessage":10417,"Notes":"selected customers","Subject":"Try the new features of XYZ product"},{"Count":1,"IdList":1,"IdMessage":11566,"Notes":"","Subject":"Email Check-Up"},{"Count":1,"IdList":1,"IdMessage":11497,"Notes":"","Subject":"Follow our webinars!"},{"Count":1,"IdList":1,"IdMessage":11142,"Notes":"","Subject":"Improve your delivery rate"},{"Count":3,"IdList":1,"IdMessage":10961,"Notes":" ","Subject":"Email and smartphones"},{"Count":1,"IdList":1,"IdMessage":10820,"Notes":"","Subject":"Important update"},{"Count":1,"IdList":1,"IdMessage":10624,"Notes":"","Subject":"Check out the new plugin"}],"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/11826/List/Clicks?PageSize=5&PageNumber=1 (change page size to 5 and retreive the second page)

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

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.

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

JSON request (example)

none

JSON response (example)

UrlClicksDetails 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

 Click here to expand...
{"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)

Read bounces by 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)

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)

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

 

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)

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

 Click here to expand...
{"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}

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

 Click here to expand...
{"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":"monica@example.com","IdMessage":11775,"IdRecipient":1419659,"Notes":"","Subject":"Join our webinar","Type":"MBSD "},{"Email":"monica@example.com","IdMessage":11766,"IdRecipient":1419659,"Notes":"","Subject":"Mastering Kung Fu","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.

 

  • 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)

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).

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

 Click here to expand...

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

{"IsPaginated":false,"Items":[{"IdList":1,"IdMessage":11775,"Notes":"","Subject":"Join our webinar"}],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":1}

Paging and filtering (example)

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

  • /Recipient/1419828/List/Unsubscriptions?PageSize=10&PageNumber=1 (change page size to 10 and retreive the second page)
  • No labels