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

Info

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

Table of Contents

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)

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

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

...

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

Info

title	Important

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 bases URLs when working with REST API ("Console", "Statistics" and "Public")

The 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 times that is 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 can test the caller application in its edge cases, in such a way that even a huge number of opens, delivered emails, or clicks do not represent a problem.

Filtering does not apply to the Count parameter

On this page:

Table of Contents

...

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 the 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 organize more campaigns with it, you should be aware that the message statistics of a specific campaign cannot be handled separately from the statistics of the other campaigns made with the same message. If you need to separate the statistics of each campaign, it is recommended that you clone the message (i.e. make a copy) whenever you are planning a new campaign.

Read message recipients

Please note that the full list of message recipients is kept inside MailUp kept for the period of data retention set for the console, however up to 12 months after message sending. After that period COUNT returns zero and LIST returns an empty array.

Description

Get recipients to whom the specified message was sent

HTTP Method

GET

URL

Get recipients to whom the specified message was sent (COUNT), even if the recipient is no longer in the platform's list.

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

Get a list of email addresses to whom the specified message was sent (LIST, paging is set as default with pageSize=20). Recipients no longer in the platform's list are not included.

Code Block
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 returns the number of sent messages (e.g. 103)

LIST method returns a paged list

Expand

Code Block
{"IsPaginated":true,"Items":[{"Email":"tim@example.com","IdMessage":11826,"IdRecipient":

1376721

1405754},{"Email":"

george@example

mary@example.com","IdMessage":11826,"IdRecipient":

1376600

1403161},{"Email":"

david@example

jack@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)

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":false,"Items":[{"Count":1,"Email":"susan@example

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

1386049

1381517},{

"Count":1,

"Email":"naomi@example.com","IdMessage":11826,"IdRecipient":1377532},{"Email":"jimmy@example.com","IdMessage":11826,"IdRecipient":1377528},{

"Count":4,

"Email":"tony@networkweb.net","IdMessage":11826,"IdRecipient":1377527},{"Email":"larry@example.com","IdMessage":11826,"IdRecipient":1377520},{

"Count

:1,"

Email":"

pedro@example

pamela@example.com","IdMessage":11826,"IdRecipient":

319189

1377516},{

"Count":1,

"Email":"

kevin@example

martin@example.com","IdMessage":11826,"IdRecipient":

316618

1377047},{

"Count

:1,"

Email":"

kris@example

jenny@example.com","IdMessage":11826

,"IdRecipient":309309}

{

Count

IdRecipient":

1

1376721},{"Email":"

barbie@example

george@example.com","IdMessage":11826,"IdRecipient":

307408

1376600},{

"Count":3,

"Email":"

ken@example

david@example.com","IdMessage":11826,"IdRecipient":

303812

374939}],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":

8

54}

Paging and filtering (example)

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

/Message/11826/List/

Views

Recipients?PageSize=

5

10&PageNumber=1 (change page size to

5

10 and retreive the second page)

Read message

...

opens

Full details about clicks 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

clicks

HTTP Method
opens for the specified message

GET

URL

Get the number of clicks for the specified message (COUNT

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

Count/Clicks

Get

List/Views

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

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

Expand Code Block{"IsPaginated":true,"Items":[

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

dottie@yahoo.it"

kris@example.com","IdMessage":11826,"IdRecipient":

1419867

309309},{"Count":1,"Email":"

test@libero.it"

barbie@example.com","IdMessage":11826,"IdRecipient":

1419861

307408},{"Count":

2

3,"Email":"

genny@example

ken@example.com","IdMessage":11826,"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

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 clicks by message

Full details about clicks are kept for 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)

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

Code Block
https://services.mailup.com/API/v1.1/Rest/MailStatisticsService.svc/Message/{ID_MESSAGE}/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 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

Code Block
{"IsPaginated":true,"Items":[{"Count":1,"Email":"dottie@yahoo.it","IdRecipient":1419867},{"Count":1,"Email":"

francis@example

test@libero.

com

it","IdRecipient":

1419575

1419861},{"Count":

1

2,"Email":"

frank61@example

genny@example.com","IdRecipient":

1419568

1419852},{"Count":

1

2,"Email":"

anna@example

wayne@example.com","IdRecipient":

1419561

1419829},{"Count":1,"Email":"

adrian@example

manuel@example.com","IdRecipient":

1419552

1419828},{"Count":

1

3,"Email":"

rita@example

info1@example.com","IdRecipient":

1419537

1419809}

]

,{"

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)

Read details about clicked links

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

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

628

2,"

IdMessage

Email":

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"

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

86

1,"

IdMessage

Email":

11775

"anna@example.com","

Url

IdRecipient":

"Unsubscribe"

1419561},{"Count":

24

1,"

IdMessage

Email":

11775,"Url":"http:\/\/www.example

"adrian@example.com"

}

{

Count

IdRecipient":

68

1419552},{"

IdMessage

Count":

11775

1,"

Url

Email":"

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

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)

Read details about clicked links

Full details about clicks are kept for 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

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

http:\/\/www.example.com\/votenewsletter.asp

Read in web browser"},{"Count":

10

628,"IdMessage":11775,"Url":"http:\/\/www.example.com\/landing-page\/freetrial-12\/

responsability

tryme30days.

htm

asp"},{"Count":

3

283,"IdMessage":11775,"Url":"http:\/\/

newsletter

blog.

mailupnet

example.

it

com\/

frontend\/track.aspx?url=http:

2014\/04\/

www.example.com\/votenewsletter.asp?id=2

update-machinery\/ "},{"Count":

4

59,"IdMessage":11775,"Url":"http:\/\/

twitter

www.example.com\/

acme

pec ipsettings.htm"},{"Count":

4

123,"IdMessage":11775,"Url":"https:\/\/

twitter

www.youtube.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=&

watch?v=su896YA0gC3A&feature=youtu.be"},{"Count":86,"IdMessage":11775,"Url":"Unsubscribe"},{"Count":

3

24,"IdMessage":11775,"Url":"

http:\/\/newsletter.mailupnet.it\/frontend\/track.aspx?url=

http:\/\/www.example.com

\/votenewsletter.asp?id=4

"},{"Count":

8

68,"IdMessage":11775,"Url":"http:\/\/

e

www.

acme

example.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":"

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.

example

facebook.com\/pages\/acme\/

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)

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"

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

IdRecipient

Url":

1419650,

Type":"SBDF "},{"Email":"max@yahoooo.it","IdMessage":11775,"IdRecipient":1419635,"Type":"HB "},{"Email":"infos@homail.com","IdMessage":11775,"IdRecipient":1419632,"Type":"HB

http:\/\/newsletter.mailupnet.it\/frontend\/track.aspx?url=http:\/\/www.example.com\/votenewsletter.asp?id=4"},{"

Email

Count":

"info@wrongaddress.com"

8,"IdMessage":11775,"

IdRecipient

Url":

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 who clicked unsubscription link

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

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 the link and with a 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 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)

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 returns the number of bounces (e.g. 103)

LIST method returns a paged list

Expand

Disclaimer: addresses used in the example here below 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":

1419828

"HB "},{"Email":"

manuel

alice@gmmail.

f@example.com

it","IdMessage":11775,"IdRecipient":1419467,"

:1419828

Type":"MBSD "},{"Email":"

manuel

fax@hotmeils.

f@example.com

it","IdMessage":11775,"IdRecipient":1419068,"Type":

1419828

"GB "},{"Email":"

agency@example

informationes@nweb.com","IdMessage":11775,"IdRecipient":1418795,"Type":

1419668

"GB "},{"Email":"

agency@example

clas@gimail.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

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 unsubscribed recipients by message

This feature allows extracting either the number or the full list of the recipients whose unsubscription is related to a specified message.

Description

Get recipients whose unsubscription is related to the specified message

HTTP Method

GET

URL

Get the number of unsubscribed (COUNT)

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

Get a detailed list of unsubscribed (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 returns the number of unsubscribed recipients (e.g. 103)

LIST method returns a paged list

Expand

Code Block
{"IsPaginated":true,"Items":[{"Email":"manuel.f@example.com","IdMessage":11775,"IdRecipient":

1419246

1419828},{"Email":"

luca@example

agency@example.com","IdMessage":11775,"IdRecipient":

1419184

1419668},
{"Email":"

luca@example

barbie@example.com","IdMessage":11775,"IdRecipient":

1419184

1419568},
{"Email":"

info@example

matt@example.com","IdMessage":11775,"IdRecipient":

1419095

1419482},
{"Email":"

info@example

peter@example.com","IdMessage":11775,"IdRecipient":

1419095

1419246},
{"Email":"

info@example

luca@example.com","IdMessage":11775,"IdRecipient":

1419095

1419184},
{"Email":"

sales@example

info@example.com","IdMessage":11775,"IdRecipient":

1418646

1419095},{"Email":"sales@example.com","IdMessage":11775,"IdRecipient":1418646}],"PageNumber":0,"PageSize":

20

8,"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 the recipient ID by using the "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.

...

Please note that delivery details are kept inside MailUp only for 15 days, after kept for the period of data retention set for the console, however up to 12 months. After that period COUNT returns zero and LIST returns an empty array.

Description	Get

recipients that received the specified message

the email messages sent to the specified recipient
HTTP Method	GET
URL	Get the

number of recipients that received

email messages sent to the specified

message

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

the email messages sent to 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

returns 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

retrieve the second page)

If you want to

retreive

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

/Recipient/1378914/List/Deliveries?filterby="IdList+%3d%3d+51"

Read opens by the recipient

Full details about opens are kept for 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

recipient
HTTP Method	GET
URL	Get the number of opens for the specified

message

recipient (COUNT)

Code Block
https://services.mailup.com/API/v1.1/Rest/MailStatisticsService.svc/

Message

Recipient/

{ID

@id_

MESSAGE}

Recipient/Count/Views

Get a list of

recipients

messages that were opened by the specified

message

recipient (LIST, paging is set as default with pageSize=20)

Code Block
https://services.mailup.com/API/v1.1/Rest/MailStatisticsService.svc/

Message

Recipient/

{ID

@id_

MESSAGE}

Recipient/List/Views

JSON request (example)

none

JSON response (example)

COUNT method simply

return

returns the number of opens (e.g. 13)

LIST method returns a detailed list of

recipients that

opened

the message

messages (each

recipient

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.

/

Message

Recipient/

11826

300501/List/Views?PageSize=5&PageNumber=1 (change page size to 5 and

retreive

retrieve the second page)

If you want to

retreive

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)

/Recipient/300501/List/Views?filterby="IdList+%3d%3d+51"

If you want to

retreive

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)

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

=2)

Read clicks by the 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" optionkept for the period of data retention set for the console.

Description	Get clicks performed by the specified recipient
HTTP Method	GET
URL	Get the number of clicks for

the specified message (COUNT

the specified message (COUNT)

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

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

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

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

Expand Code Block{"IsPaginated":false,"Items":[

/Rest/MailStatisticsService.svc/Recipient/@id_Recipient/List/Clicks

JSON request (example)

none

JSON response (example)

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

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 "},{"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":

87

51,"IdMessage":

11658

11554,"Notes":"

List Plus by Mike Brown

","Subject":"

Higlhights

☑

New

Get

Media

your

2014

free

Feb

trial

10th

account"},{"Count":1,"IdList":

87

51,"IdMessage":

11090

11531,"Notes":"

List Plus by Mike Brown

A+B","Subject":"

Higlhights

♛

New

Learn

Media

the

2013

golden

July 3rd

rules"},{"Count":

2

1,"IdList":

80

51,"IdMessage":

10598

11442,"Notes":"

internal email

","Subject":"

Company

Market

Events

watch"},{"Count":1,"IdList":51,"IdMessage":

11575

11380,"Notes":"not customers:

Xmas

version

newsletter

A","Subject":"

[name], get your XMas coupon

Market watch"},{"Count":1,"IdList":51,"IdMessage":

11554

11288,"Notes":"not customers, with embedded images","Subject":"

☑ Get your free trial account

Market watch"},{"Count":1,"IdList":51,"IdMessage":

11531

10970,"Notes":"

A+B

","Subject":"

♛

Email

Learn the golden rules

and smartphones"},{"Count":

1

2,"IdList":51,"IdMessage":

11442

10634,"Notes":"","Subject":"

Market watch

Inbox"},{"Count":

1

2,"IdList":51,"IdMessage":

11380

953,"Notes":"

not customers: version A

Invitation","Subject":"

Market watch

Invite for marketing forum 2010 in Milan"},{"Count":1,"IdList":

51

41,"IdMessage":

11288

10621,"Notes":"

not customers, with embedded images

","Subject":"

Market watch

Get your Christmas Box"},{"Count":1,"IdList":

51

41,"IdMessage":

10970

10417,"Notes":"selected customers","Subject":"

Email and smartphones

Try the new features of XYZ product"},{"Count":

2

1,"IdList":

51

1,"IdMessage":

10634

11566,"Notes":"","Subject":"

Inbox

Email Check-Up"},{"Count":

2

1,"IdList":

51

1,"IdMessage":

953

11497,"Notes":"

Invitation

","Subject":"

Invite

Follow

for marketing forum 2010 in Milan

our webinars!"},{"Count":1,"IdList":

41

1,"IdMessage":

10621

11142,"Notes":"","Subject":"

Get

Improve your

Christmas

delivery

Box

rate"},{"Count":

1

3,"IdList":

41

1,"IdMessage":

10417

10961,"Notes":"

selected

customers

","Subject":"

Try

Email

the new features of XYZ product

and smartphones"},{"Count":1,"IdList":1,"IdMessage":

11566

10820,"Notes":"","Subject":"

Email

Important

Check-Up

update"},{"Count":1,"IdList":1,"IdMessage":

11497

10624,"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"},

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/300501/List/Clicks?PageSize=5&PageNumber=1 (change page size to 5 and retreive the second page)

Read details by recipient about clicked links

Full details about clicks are kept kept for the period of data retention set for the console.

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

JSON request (example)

none

JSON response (example)

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

1

87,"IdMessage":

10624

11658,"Notes":"List Plus by Mike Brown","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)

Read details by recipient about clicked links

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.

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

Expand Code Block{"IsPaginated":false,"Items":[

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

87

51,"IdMessage":

11658

11575,"Notes":"

List

Plus by Mike Brown

Xmas newsletter","Subject":"

Higlhights New Media 2014 Feb 10th

[name], get your XMas coupon","UrlClicks":[{"Count":1,"IdMessage":

11658

11575,"Url":"

Preference Center

http:\/\/www.xmascoupon2.com\/"}]},{"Count":1,"IdList":

87

51,"IdMessage":

11090

11554,"Notes":"

List Plus by Mike Brown

","Subject":"

Higlhights

☑

New

Get

Media

your

2013

free

July

trial

3rd

account","UrlClicks":[{"Count":1,"IdMessage":

11090

11554,"Url":"

Preference Center

http:\/\/attendee.gotowebinar.com\/register\/8702471"}]},{"Count":

2

1,"IdList":

80

51,"IdMessage":

10598

11531,"Notes":"

internal email

A+B","Subject

":"Company Events

":"♛ Learn the golden rules","UrlClicks":[{"Count":

2

1,"IdMessage":

10598

11531,"Url":"http:\/\/

cremonapalacehotel.it\/

www.example.com\/ebooks_conferma\/sms-marketing.asp?email=cigoli@nweb.it"}]},{"Count":1,"IdList":51,"IdMessage":

11575

11442,"Notes":"

Xmas newsletter

","Subject":"

[name], get your XMas coupon

Market watch","UrlClicks":[{"Count":1,"IdMessage":

11575

11442,"Url":"http:\/\/www.

xmascoupon2

example.com\/ebooks_conferma\/osservatorio-mailup-2013.asp"}]},{"Count":1,"IdList":51,"IdMessage":

11554

11380,"Notes":"not customers: version A","Subject":"

☑ Get your free trial account

Market watch","UrlClicks":[{"Count":1,"IdMessage":

11554

11380,"Url":"http:\/\/

attendee

www.

gotowebinar

example.com\/

register

ebooks\/

8702471

marketwatch2013.asp"}]},{"Count":1,"IdList":51,"IdMessage":

11531

11288,"Notes

":"A+B

":"not customers, with embedded images","Subject":"

♛ Learn the golden rules

Market watch","UrlClicks":[{"Count":1,"IdMessage":

11531

11288,"Url":"http:\/\/www.example.com\/email-marketing-ebooks

_conferma

\/

sms

html-email-marketing.asp?email=

cigoli@nweb.it

mike@example.com&code=12345"}]},{"Count":1,"IdList":51,"IdMessage":

11442

10970,"Notes":"","Subject":"

Market

Email and

watch

smartphones","UrlClicks":[{"Count":1,"IdMessage":

11442

10970,"Url":"http:\/\/www.example.com\/email-marketing-ebooks

_conferma

\/

osservatorio

mobile-

mailup

email-

2013

marketing.asp"}]},{"Count":

1

2,"IdList":51,"IdMessage":

11380

10634,"Notes":"

not customers: version A

","Subject":"

Market watch

Inbox","UrlClicks":[{"Count":1,"IdMessage":

11380

10634,"Url":"http:\/\/www.example.com

\/ebooks\/marketwatch2013.asp

\/email-marketing-ebooks\/delivery.asp"},{"Count":1,"IdMessage":10634,"Url":"Lettura nel browser web"}]},{"Count":

1

2,"IdList":51,"IdMessage":

11288

953,"Notes":"

not customers, with embedded images

Invitation","Subject":"

Market watch

Invite for marketing forum 2010 in Milan","UrlClicks":[{"Count":

1

2,"IdMessage":

11288

953,"Url":"http:\/\/www.

example.com\/email-marketing-ebooks\/html-email-marketing.asp?email=mike@example.com&code=12345

mktforum2010.it\/"}]},{"Count":1,"IdList":

51

41,"IdMessage":

10970

10621,"Notes":"","Subject":"

Email

Get your

and

Christmas

smartphones

Box","UrlClicks":[{"Count":1,"IdMessage":

10970

10621,"Url":"

http:\/\/www.example.com\/email-marketing-ebooks\/mobile-email-marketing.asp

Lettura nel browser web"}]},{"Count":

2

1,"IdList":

51

41,"IdMessage":

10634

10417,"Notes":"selected customers","Subject":"

Inbox

Try the new features of XYZ product","UrlClicks":[{"Count":1,"IdMessage":

10634

10417,"Url":"

http:\/\/www.example.com\/email-marketing-ebooks\/delivery.asp"},{"Count":1,"IdMessage":10634,"Url":"Lettura nel browser web

Form autoprofilazione: 54"}]},{"Count":

2

1,"IdList":

51

1,"IdMessage":

953

11566,"Notes":"

Invitation

","Subject":"

Invite for marketing forum 2010 in Milan

Email Check-Up","UrlClicks":[{"Count":

2

1,"IdMessage":

953

11566,"Url":"http:\/\/

www

blog.

mktforum2010.it

example.com\/2013\/12\/choose-the-right-header\/"}]},{"Count":1,"IdList":

41

1,"IdMessage":

10621

11497,"Notes":"","Subject":"

Get

Follow

your Christmas Box

our webinars!","UrlClicks":[{"Count":1,"IdMessage":

10621

11497,"Url":"

Lettura nel browser web

http:\/\/www.example.com\/new-features-2013.htm"}]},{"Count":1,"IdList":

41

1,"IdMessage":

10417

11142,"Notes":"

selected customers

","Subject":"

Try

Improve

the

your

new features of XYZ product

delivery rate","UrlClicks":[{"Count":1,"IdMessage":

10417

11142,"Url":"

Form autoprofilazione: 54

http:\/\/blog.example.com\/2013\/07\/email-check-up\/"}]},{"Count":

1

3,"IdList":1,"IdMessage":

11566

10961,"Notes":" ","Subject":"Email and

Check-Up

smartphones","UrlClicks":[{"Count":

1

2,"IdMessage":

11566

10961,"Url":"http:\/\/blog.example.com\/2013\/

12

05\/

choose

brcomr-

the-right-header\/

industry-partner\/"},{"Count":1,"IdMessage":10961,"Url":"http:\/\/blog.example.com\/2013\/05\/mobile"}]},{"Count":1,"IdList":1,"IdMessage":

11497

10820,"Notes":"","Subject":"

Follow our webinars!

Important update","UrlClicks":[{"Count":1,"IdMessage":

11497

10820,"Url":"http:\/\/

www

blog.example.com\/2013\/

new-features-2013.htm

03\/product-management"}]},{"Count":1,"IdList":1,"IdMessage":

11142

10624,"Notes":"","Subject":"

Improve

Check out

your

the

delivery

new

rate

plugin","UrlClicks":[{"Count":1,"IdMessage":

11142

10624,"Url":"http:\/\/blog.example.com\/

2013

2012\/

07

12\/

email

plugin-

check-up

updates\/"}]}],

{

Count

PageNumber":

3

0,"

IdList

PageSize":

1

20,"

IdMessage

Skipped":

10961

0,"

Notes

TotalElementsCount":

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

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

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

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

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

Get a detailed list of messages in which a bounce condition occurred for a 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/BouncesDetails

JSON request (example)

none

JSON response (example)

COUNT method simply returns 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}

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

Expand

Code Block
{"IsPaginated":false,"Items":[{"Email":"monica@example.com","IdMessage":11824,"IdRecipient":1419659,"Notes":"

monica@example.com

Martial Arts 02","

IdMessage

Subject":

11824,"IdRecipient":1419659

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

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

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

":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 the recipient

This feature allows extracting either the unsubscriptions made by a specified recipient

Description

Get information about the unsubscriptions by the specified recipient

HTTP Method

GET

URL

Get the number of clicks on an "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 the "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 returns the number of recipients who clicked on Unsubscribe 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,"Notes":"","Subject":"

Mastering

Join

Kung Fu","Type":"MBSD

our webinar"}],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":

4

1}

Paging and filtering (example)

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

/Recipient/

1419659

1419828/List/

Bounces

Unsubscriptions?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,"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

Access to built-in pages for email statistics

MailUp also provides some public pages that display some of the available statistics. These pages do not provide all the details you can obtain by properly combining the methods listed above, but in some cases, it could be an acceptable tradeoff. (Note: you may also use the returned URL to extract the account URL)

Description

Get a list of public pages

HTTP Method

GET

URL

Get a list of URLs

Code Block
https://services.mailup.com/API/v1.1/Rest/MailStatisticsService.svc/Message/{Message_ID}/Pages

JSON request (example)

none

JSON response (example)

Expand

title	Click here to get the list of available pages...

Overall report by message
Login page ("console" URL)
Click trend
Opens by message
Link tracking by message
Readers by message
Mailings by message ("sent" report)
Clicks split by filters*
Opens split by filters*

*this page is no longer available

Expand

This is an example provided when requesting pages related to message with ID=11118 (on list 67) for the account with URL=example.mailup.com

Code Block

{"ClickFilters":"http:\/\/example.mailup.com\/frontend\/link_tracking_filter.aspx?act=submit&idList=67&idNl=11118&listGuid=bbbbbbbb-aaaa-1111-0000-00000000000","ClickTrend":"http:\/\/example.mailup.com\/frontend\/click_views_report.aspx?act=submit&idList=67&idNl=11118&listGuid=bbbbbbbb-aaaa-1111-0000-00000000000","Console":"http:\/\/example.mailup.com\/console\/login.aspx","LinkTracking":"http:\/\/example.mailup.com\/frontend\/link_tracking.aspx?idList=67&listGuid=bbbbbbbb-aaaa-1111-0000-00000000000&idnl=11118","OpenFilters":"http:\/\/example.mailup.com\/frontend\/user_views_report_filter.aspx?idList=67&listGuid=bbbbbbbb-aaaa-1111-0000-00000000000&idnl=11118","Opens":"http:\/\/example.mailup.com\/frontend\/time_views_report.aspx?act=submit&idList=67&idNl=11118&listGuid=bbbbbbbb-aaaa-1111-0000-00000000000","Overall":"http:\/\/example.mailup.com\/frontend\/show_message_reports.aspx?idList=67&listGuid=bbbbbbbb-aaaa-1111-0000-00000000000&idnl=11118&start_date=20160503&end_date=20160518","Readers":"http:\/\/example.mailup.com\/frontend\/user_views_report.aspx?idList=67&listGuid=bbbbbbbb-aaaa-1111-0000-00000000000&idnl=11118","Sent":"http:\/\/example.mailup.com\/frontend\/send_report2.aspx?act=submit&idList=67&idNl=11118&listGuid=bbbbbbbb-aaaa-1111-0000-00000000000"}

Paging and filtering (example)

Versions Compared

Old Version 7

New Version Current

Key

Get Statistics by Message

Read message recipients

Get Statistics by Message

Read message recipients

Read message opens

Read message

opens

Read clicks by message

Read details about clicked links

Read details about clicked links

Read bounces by message

Read who clicked unsubscription link

Read bounces by message

Read unsubscribed recipients by message

Get Statistics by Recipient

Read opens by the recipient

Read clicks by the recipient

Read details by recipient about clicked links

Read details by recipient about clicked links

Read bounces by recipient

Read bounces by the recipient

Read clicks on unsubscription link by the recipient

Read clicks on unsubscription link by recipient

Access to built-in pages for email statistics

Page Comparison

Versions Compared

Old Version 7

New Version Current

Key

Get Statistics by Message

Read message recipients

Get Statistics by Message

Read message recipients

Read message opens

Read message

opens

Read clicks by message

Read details about clicked links

Read details about clicked links

Read bounces by message

Read who clicked unsubscription link

Read bounces by message

Read unsubscribed recipients by message

Get Statistics by Recipient

Read opens by the recipient

Read clicks by the recipient

Read details by recipient about clicked links

Read details by recipient about clicked links

Read bounces by recipient

Read bounces by the recipient

Read clicks on unsubscription link by the recipient

Read clicks on unsubscription link by recipient

Access to built-in pages for email statistics