ReportListMessageDelivery

The ReportListMessageDelivery method retrieves a collection of message delivery statistics for messages sent to a list. This method gives users access to the report data available through the application’s Message Delivery Report. Users can specify a ListID and a date range. The method will return a list of message delivery metrics for each message sent within the specified date range.

<< Back to Method List

SOAP 1.1 Request

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /v31/IntegrationService.asmx HTTP/1.1
Host: webservices.listrak.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://webservices.listrak.com/v31/ReportListMessageDelivery"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <WSUser xmlns="http://webservices.listrak.com/v31/">
      <UserName>string</UserName>
      <Password>string</Password>
    </WSUser>
  </soap:Header>
  <soap:Body>
    <ReportListMessageDelivery xmlns="http://webservices.listrak.com/v31/">
      <ListID>int</ListID>
      <StartDate>dateTime</StartDate>
      <EndDate>dateTime</EndDate>
      <IncludeTestMessages>boolean</IncludeTestMessages>
      <WSException>
        <SoapMethod>string</SoapMethod>
        <DateTime>dateTime</DateTime>
        <Description>string</Description>
      </WSException>
    </ReportListMessageDelivery>
  </soap:Body>
</soap:Envelope>

SOAP 1.1 Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ReportListMessageDeliveryResponse xmlns="http://webservices.listrak.com/v31/">
      <ReportListMessageDeliveryResult>
        <WSMessageDelivery>
          <ListID>int</ListID>
          <MsgID>int</MsgID>
          <Subject>string</Subject>
          <SendDate>dateTime</SendDate>
          <DeliverCount>int</DeliverCount>
          <DeliverPercent>decimal</DeliverPercent>
          <BounceCount>int</BounceCount>
          <BouncePercent>decimal</BouncePercent>
          <PassAlongCount>int</PassAlongCount>
        </WSMessageDelivery>
        <WSMessageDelivery>
          <ListID>int</ListID>
          <MsgID>int</MsgID>
          <Subject>string</Subject>
          <SendDate>dateTime</SendDate>
          <DeliverCount>int</DeliverCount>
          <DeliverPercent>decimal</DeliverPercent>
          <BounceCount>int</BounceCount>
          <BouncePercent>decimal</BouncePercent>
          <PassAlongCount>int</PassAlongCount>
        </WSMessageDelivery>
      </ReportListMessageDeliveryResult>
      <WSException>
        <SoapMethod>string</SoapMethod>
        <DateTime>dateTime</DateTime>
        <Description>string</Description>
      </WSException>
    </ReportListMessageDeliveryResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2 Request

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /v31/IntegrationService.asmx HTTP/1.1
Host: webservices.listrak.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <WSUser xmlns="http://webservices.listrak.com/v31/">
      <UserName>string</UserName>
      <Password>string</Password>
    </WSUser>
  </soap12:Header>
  <soap12:Body>
    <ReportListMessageDelivery xmlns="http://webservices.listrak.com/v31/">
      <ListID>int</ListID>
      <StartDate>dateTime</StartDate>
      <EndDate>dateTime</EndDate>
      <IncludeTestMessages>boolean</IncludeTestMessages>
      <WSException>
        <SoapMethod>string</SoapMethod>
        <DateTime>dateTime</DateTime>
        <Description>string</Description>
      </WSException>
    </ReportListMessageDelivery>
  </soap12:Body>
</soap12:Envelope>

SOAP 1.2 Response

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ReportListMessageDeliveryResponse xmlns="http://webservices.listrak.com/v31/">
      <ReportListMessageDeliveryResult>
        <WSMessageDelivery>
          <ListID>int</ListID>
          <MsgID>int</MsgID>
          <Subject>string</Subject>
          <SendDate>dateTime</SendDate>
          <DeliverCount>int</DeliverCount>
          <DeliverPercent>decimal</DeliverPercent>
          <BounceCount>int</BounceCount>
          <BouncePercent>decimal</BouncePercent>
          <PassAlongCount>int</PassAlongCount>
        </WSMessageDelivery>
        <WSMessageDelivery>
          <ListID>int</ListID>
          <MsgID>int</MsgID>
          <Subject>string</Subject>
          <SendDate>dateTime</SendDate>
          <DeliverCount>int</DeliverCount>
          <DeliverPercent>decimal</DeliverPercent>
          <BounceCount>int</BounceCount>
          <BouncePercent>decimal</BouncePercent>
          <PassAlongCount>int</PassAlongCount>
        </WSMessageDelivery>
      </ReportListMessageDeliveryResult>
      <WSException>
        <SoapMethod>string</SoapMethod>
        <DateTime>dateTime</DateTime>
        <Description>string</Description>
      </WSException>
    </ReportListMessageDeliveryResponse>
  </soap12:Body>
</soap12:Envelope>