Page tree
Skip to end of metadata
Go to start of metadata

In this section:

 WS_MailUpReport.ReportByMessageEN method

Generates an XML response with statistics (clicks and opens) for the specified message.

  • string ReportByMessageEN(string accessKey, int listID, int messageID) 
    • accessKey: access key obtained using the LoginFromId method, which must be used to authenticate all other calls 
    • listID: the ID of the list to which the message belongs
    • messageID: the ID of the message for which statistics are being requested


SOAP Examples

SOAP request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://services.mailupnet.it/WS">
<soapenv:Header/>
	<soapenv:Body>
		<ws:ReportByMessageEN>
		<!--Use accessKey value that is returned by LoginFromId method-->
		<ws:accessKey>HzAgwRRJaAKBtkgNWpkAuURfV4SxMm6T3HJegRuSkUivKJElNNcmSQe8nqGyoM9</ws:accessKey>
		<ws:listID>1</ws:listID>
		<ws:messageID>32</ws:messageID>
		</ws:ReportByMessageEN>
	</soapenv:Body>
</soapenv:Envelope>
SOAP response
<ReportByMessageENResult>
  <errorCode>0</errorCode>
  <errorDescription></errorDescription>
  <!-- 01 Clicks on generic links inside the newsletter -->
  <Clicks Url="http://twitter.com/home?status=NBA newsletter!http://news.nbafans.com/frontend/nl_preview_window.aspx?idNL=568"
  Total="19">
    <Click Email="james@heat.com" Total="1" />
    <Click Email="durant@thunders.com" Total="2" />  
	<!-- Other recipients (sum of total clicks by recipient must match with total clicks for specified URL) -->
    <Click Email="bryant@lakers.com" Total="3" />
  </Clicks>
  <Clicks Url="http://www.facebook.com/share.php?u=http://news.nbafans.com/frontend/nl_preview_window.aspx?idNL=568&amp;t=I love this game!"
  Total="12">
    <Click Email="garnett@celtics.com" Total="3" />
    <Click Email="gallinari@nuggets.com" Total="1" />
    <!-- Other recipients (sum of total clicks by recipient must match with total clicks for specified URL) -->
    <Click Email="bynum@lakers.com" Total="1" />
  </Clicks>
  <Clicks Url="http://www.basketfans.org/news.htm" Total="1455">
    <Click Email="15113@example.com" Total="1" />
    <Click Email="mike@nweb.it" Total="1" />
    <!-- Other recipients (sum of total clicks by recipient must match with total clicks for specified URL) -->
    <Click Email="john@test.it" Total="1" />
  </Clicks>
  <Clicks Url="www.basketfans.org/events.htm" Total="1">
    <Click Email="dario@example.com" Total="1" />
  </Clicks>
  
  <!-- 02 Clicks on links that contain dynamic fields (each fields combination is tracked as a different URL -->
  <Clicks Url="http://www.basketfans.org/register/changesubscription.php?m=steve@test.com&amp;d=19691224"  Total="1">
    <Click Email="steve@test.com" Total="1" />
  </Clicks>
   <Clicks Url="http://www.basketfans.org/register/changesubscription.php?m=maria@example.com&amp;d=19700309"  Total="1">
    <Click Email="maria@example.com&" Total="1" />
  </Clicks>
  
  <!-- 03 Views in browser -->
  <Clicks Url="View in browser" Total="866"> <!-- fixed name, "Lettura nel browser Web" for the italian version -->
    <Click Email="delavega@zorro.com" Total="1" />
    <Click Email="garnett@celtics.com" Total="5" />
    <!-- Other recipients (sum of total clicks by recipient must match with total clicks for "View in browser" cases) --> 
    <Click Email="durant@thunders.com" Total="1" />
  </Clicks>
  
  <!-- 04 Openings -->
  <Opens Total="40659">
    <Open Email="ozzy@example.com" Total="1" />
    <Open Email="gene@test.org" Total="1" />
	<!-- Other recipients (sum of total openings by recipient must match with total openinigs) -->   
   <Open Email="lorem@ipsum.org" Total="1" />
  </Opens>
</ReportByMessageENResult>

 

WS_MailUpReport.ReportByUserEN method

Generates an XML response with statistics (bounces, clicks, opens) and personal data for the specified subscriber.

  • string ReportByUserEN(string accessKey, string email, int listID, int messageID) 
    • accessKey: access key obtained using the LoginFromId method, which must be used to authenticate all other calls 
    • email: the e-mail address of the subscriber whose statistics are being requested
    • listID: the ID of the list to which the message belongs
    • messageID: the ID of the message for which statistics are being requested. If 0, all messages in the list will be included.

In the event that the status of the e-mail is unsubscribed, the statistics will not be returned.

SOAP Examples

SOAP request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://services.mailupnet.it/WS">
<soapenv:Header/>
	<soapenv:Body>
		<ws:ReportByUserEN>
			<!--Use accessKey value that is returned by LoginFromId method-->
			<ws:accessKey>HzAgwRRJaAKBtkgNWpkAuURfV4SxMm6T3HJegRuSkUivKJElNNcmSQe8nqGyoM9</ws:accessKey>
	         	<ws:email>mary@example.com</ws:email>
			<ws:listID>100</ws:listID>
         		<ws:messageID>0</ws:messageID>
		</ws:ReportByUserEN>
	</soapenv:Body>
</soapenv:Envelope>


SOAP response
<ReportByUserENResult>
  <errorCode>0</errorCode>
  <errorDescription></errorDescription>
  <Channels>
    <!-- Available values for channels are: Subscribed, Unsubscribed, Pending, Not Registered -->
    <Email>Subscribed</Email>
    <SMS>Not Registered</SMS>
    <RegularMail>Not Registered</RegularMail>
    <Voice>Unsubscribed</Voice>
    <Fax>Unsubscribed</Fax>
  </Channels>
  <!-- Date and time of last Bounce (or "No bounces") -->
  <!-- When recipient is unsubscribed due to bounce the displayed value is "Unsubscribed" -->
  <Bounce>7/26/2012 12:44:20 PM</Bounce>
  <BounceDetails>
    <Message DateTime="7/26/2012 12:44:20 PM" BounceCode="" BounceType="GB" MessageID="21"/>
  </BounceDetails>
  <Clicks Url="http://www.mailup.com" Total="1">
    <Click DateTime="6/15/2012 2:12:43 PM" IP="71.88.224.110"
    MessageID="32" Subject="Text Font" />
  </Clicks>
  <Clicks Url="http://www.mailup.it" Total="1">
    <Click DateTime="6/15/2012 2:12:56 PM" IP="71.88.224.110"
    MessageID="32" Subject="Text Font" />
  </Clicks>
  <Clicks Url="Send To a Friend" Total="3">
    <Click DateTime="6/15/2012 2:14:08 PM" IP="71.88.224.110"
    MessageID="32" Subject="Text Font" />
    <Click DateTime="6/15/2012 2:14:08 PM" IP="71.88.224.110"
    MessageID="32" Subject="Text Font" />
    <Click DateTime="6/15/2012 2:14:08 PM" IP="71.88.224.110"
    MessageID="32" Subject="Text Font" />
  </Clicks>
  <Clicks Url="View in your browser" Total="2">
    <Click DateTime="6/15/2012 2:33:16 PM" IP="71.88.224.110"
    MessageID="32" Subject="Text Font" />
    <Click DateTime="6/15/2012 2:33:16 PM" IP="71.88.224.110"
    MessageID="32" Subject="Text Font" />
  </Clicks>
  <Opens Total="4">
    <Open DateTime="6/15/2012 2:12:38 PM" IP="71.88.224.110"
    MessageID="32" Subject="Text Font" />
    <Open DateTime="6/15/2012 2:12:38 PM" IP="71.88.224.110"
    MessageID="32" Subject="Text Font" />
    <Open DateTime="6/15/2012 2:12:38 PM" IP="71.88.224.110"
    MessageID="32" Subject="Text Font" />
    <Open DateTime="6/15/2012 2:12:38 PM" IP="71.88.224.110"
    MessageID="32" Subject="Text Font" />
  </Opens>
  <LatestSent> 
    <!-- here are listed the message that have been sent to that recipient in the last two weeks, including those that were non open nor clicked -->
    <Message DateTime="10/22/2012 7:21:36 PM" MessageID="107" Subject="RSS News 2"/>
    <Message DateTime="10/18/2012 5:34:12 PM" MessageID="106" Subject="RSS News 1"/>
  </LatestSent>
  <PersonalDataFields>
    <Field Id="1" Value="Mary" />
    <Field Id="2" Value="Poppins" />
    <Field Id="3" Value="ACME" />
    <Field Id="4" Value="London" />
    <Field Id="5" Value="12345" />
    <Field Id="6" Value="56789" />
    <Field Id="7" Value="English" />
    <Field Id="8" Value="Car" />
    <Field Id="9" Value="Margherita" />
    <Field Id="10" Value="Young inside ;)" />
    <Field Id="11" Value="All" />
    <Field Id="12" Value="F" />
    <Field Id="13" Value="Martial arts" />
    <Field Id="14" Value="1" />
    <Field Id="15" Value="No" />
    <Field Id="16" Value="2345" />
    <Field Id="17" Value="6789" />
    <Field Id="18" Value="" />
    <Field Id="19" Value="" />
    <Field Id="20" Value="" />
    <Field Id="21" Value="" />
    <Field Id="22" Value="" />
    <Field Id="23" Value="" />
    <Field Id="24" Value="" />
    <Field Id="25" Value="" />
    <Field Id="26" Value="" />
    <Field Id="27" Value="" />
    <Field Id="28" Value="" />
    <Field Id="29" Value="" />
    <Field Id="30" Value="" />
    <Field Id="31" Value="" />
    <Field Id="32" Value="" />
    <Field Id="33" Value="" />
    <Field Id="34" Value="" />
    <Field Id="35" Value="" />
    <Field Id="36" Value="" />
    <Field Id="37" Value="" />
    <Field Id="38" Value="" />
    <Field Id="39" Value="" />
  </PersonalDataFields>
</ReportByUserENResult>

IMPORTANT: Fax channel is currently available for the Italian market only, while voice and regular mail are no more available.
"Pending" status refers to a subscriber that has not yet confirmed his/her subscription by clicking on the corresponding link in the subscription confirmation request message.
  • No labels

4 Comments

  1. Anonymous

    Is it possible to obtain the count of subscribers in list?

    And number of subscribers (recipients) per message?

    1. These numbers are not available with SOAP API. At the moment you can access to these data only by accessing MailUp console, but they will available soon in the new REST API (coming soon).

      Anyway, thank you for your feedback, we will consider your request as a hint to future enhancements on SOAP API.

      Regards

  2. Anonymous

    Will also be possible to obtain the list of bounced email addresses for the sent messages?

    1. Not with SOAP API. Available alternative solutions are:

      • batch export of bounces using FTP
      • REST API (available very soon, please contact us if you are interested in trying it)


      Regards