Page Comparison

...

Description

Get distribution of clicks for the specified message

HTTP Method

GET

URL

Count the number of clicks on each link of specified message

Code Block
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)

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

Expand

Code Block

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

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

Code Block

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

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)

Code Block
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)

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

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

Code Block

{"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)

Read unsubscriptions (from link)

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"

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

{"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)

Versions Compared

Old Version 3

New Version 4

Key

Read bounces

Read unsubscriptions (from link)