Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 18 Next »

In this section:

 WS_MailUpReport.ReportByMessage method

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

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

 

<ReportByMessageENResult>
   <errorCode></errorCode>
   <errorDescription></errorDescription>              
   <Clicks Url="" Total="">
      <Click Email="" Total="" />
      ...           
   </Cliks>
   <Opens Total="">
      <Open Email="" Total="" />
      ...
   </Opens>          
</ ReportByMessageENResult >

 

WS_MailUpReport.ReportByUser method

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

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

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

 

IMPORTANT: Fax, voice and regular mail channels are currently available for the Italian market only
"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