Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

  • 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

...

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

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>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>No bounces<<Bounce>7/26/2012 12:44:20 PM</Bounce>
  <Clicks Url="http://www.mailup.com" Total="1"><BounceDetails>
      <Click<Message DateTime="67/1526/2012 212:1244:4320 PM" IPBounceCode="71.88.224.110"     MessageID="32BounceType="GB" SubjectMessageID="Text Font21" />
  </Clicks>BounceDetails>
  <Clicks Url="http://www.mailup.itcom" Total="1">
    <Click DateTime="6/15/2012 2:12:5643 PM" IP="71.88.224.110"
    MessageID="32" Subject="Text Font" />
  </Clicks>
  <Clicks Url="Send To a Friendhttp://www.mailup.it" Total="31">
    <Click DateTime="6/15/2012 2:1412:0856 PM" IP="71.88.224.110"
    MessageID="32" Subject="Text Font" />
  </Clicks>
  <Click<Clicks DateTimeUrl="6/15/2012 2: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" />
  </Clicks>   <Clicks Url="View in your browser" Total="2">
    <Click DateTime="6/15/2012 2:3314:1608 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" />
  </Clicks>   <Opens Total="4">
    <Open<Click DateTime="6/15/2012 2:1233:3816 PM" IP="71.88.224.110"
    MessageID="32" Subject="Text Font" />
  </Clicks>
  <Open<Opens DateTimeTotal="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"
    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="TextRSS News Font2" />
    <Open<Message DateTime="610/1518/2012 25:34:12:38 PM" IP="71.88.224.110"
    MessageID="32106" Subject="TextRSS News Font1" />
  </Opens>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>

Info
IMPORTANT: Fax channel is currently available for the Italian market only, while voice and regular mail are no 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.