ApiService

Click here for a complete list of operations.

GetEngagementReport

Test

The test form is only available for requests from the local machine.

SOAP 1.1

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

POST /apiservice.asmx HTTP/1.1
Host: ea-api.litmus.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ea-api.litmus.com/GetEngagementReport"

<?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>
    <GetEngagementReport xmlns="http://ea-api.litmus.com/">
      <user>string</user>
      <password>string</password>
      <campaignGuid>string</campaignGuid>
    </GetEngagementReport>
  </soap:Body>
</soap:Envelope>

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>
    <GetEngagementReportResponse xmlns="http://ea-api.litmus.com/">
      <GetEngagementReportResult>
        <GlancedOrUnreadCount>int</GlancedOrUnreadCount>
        <SkimmedCount>int</SkimmedCount>
        <ReadCount>int</ReadCount>
        <GlancedOrUnreadPercentage>int</GlancedOrUnreadPercentage>
        <SkimmedPercentage>int</SkimmedPercentage>
        <ReadPercentage>int</ReadPercentage>
        <GlancedOrUnreadAvgPercentage>int</GlancedOrUnreadAvgPercentage>
        <SkimmedAvgPercentage>int</SkimmedAvgPercentage>
        <ReadAvgPercentage>int</ReadAvgPercentage>
      </GetEngagementReportResult>
    </GetEngagementReportResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

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

POST /apiservice.asmx HTTP/1.1
Host: ea-api.litmus.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:Body>
    <GetEngagementReport xmlns="http://ea-api.litmus.com/">
      <user>string</user>
      <password>string</password>
      <campaignGuid>string</campaignGuid>
    </GetEngagementReport>
  </soap12:Body>
</soap12:Envelope>

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>
    <GetEngagementReportResponse xmlns="http://ea-api.litmus.com/">
      <GetEngagementReportResult>
        <GlancedOrUnreadCount>int</GlancedOrUnreadCount>
        <SkimmedCount>int</SkimmedCount>
        <ReadCount>int</ReadCount>
        <GlancedOrUnreadPercentage>int</GlancedOrUnreadPercentage>
        <SkimmedPercentage>int</SkimmedPercentage>
        <ReadPercentage>int</ReadPercentage>
        <GlancedOrUnreadAvgPercentage>int</GlancedOrUnreadAvgPercentage>
        <SkimmedAvgPercentage>int</SkimmedAvgPercentage>
        <ReadAvgPercentage>int</ReadAvgPercentage>
      </GetEngagementReportResult>
    </GetEngagementReportResponse>
  </soap12:Body>
</soap12:Envelope>