Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • string ReportByMessageEN(string accessKey, int listID, int messageID) 
    • accessKey: access key obtained using the LoginLoginFromId 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

Example of ReportByMessageENResult

...


SOAP Examples

Code Block
languagehtml/xml
titleSOAP request
linenumberstrue
<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>
Code Block
languagehtml/xml
titleSOAP response
linenumberstrue
<ReportByMessageENResult>
   <errorCode><<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" />
  </Cliks>/Clicks>
  <Clicks Url="www.basketfans.org/events.htm" Total="1">
    <Opens<Click Email="dario@example.com" Total="1" />
  </Clicks>
  
  <!-- 02 Clicks on links that  <Opencontain 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" />
 </Opens> </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" />
  </ ReportByMessageENResult >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 LoginLoginFromId 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.Example of ReportByUserResult

SOAP Examples

Code Block
languagehtml/xml
titleSOAP request
linenumberstrue
<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>


Code Block
languagehtml/xml
titleSOAP response
linenumberstrue
<ReportByUserENResult>
  <errorCode></errorCode>
  <errorDescription></errorDescription>
  <Channels>
     <Email>Subscribed|Unsubscribed|Pending|Not Registered</Email>
     <SMS>Subscribed|Unsubscribed|Pending|Not Registered</SMS>
     <RegularMail>Subscribed|Unsubscribed|Pending|Not Registered</RegularMail>
     <Voice>Subscribed|Unsubscribed|Pending|Not Registered</Voice>
     <Fax>Subscribed|Unsubscribed|Pending|Not Registered</Fax>
  </Channels>
  <Bounce>Date and time of last Bounce</Bounce>
  <Clicks Url="" Total="">
        <Click DateTime="" IP="" MessageID="" Subject="" />
        ...       
  </Clicks>
  <Opens Total="">
        <Open DateTime="" IP="" MessageID="" Subject="" />
        ...
  </Opens>
  <PersonalDataFields>
        <Field Id="1" Value="" />
        ...
        <Field Id="39" Value="" />
  </PersonalDataFields>
</ReportByUserENResult>
Info
IMPORTANT: Fax channel is currently available for the Italian market only, while voice and regular mail channels are currently available for the Italian market onlyno more available.
Info
"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.