ApiService

Click here for a complete list of operations.

GetDetailedEngagementReport

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/GetDetailedEngagementReport"

<?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>
    <GetDetailedEngagementReport xmlns="http://ea-api.litmus.com/">
      <user>string</user>
      <password>string</password>
      <campaignGuid>string</campaignGuid>
    </GetDetailedEngagementReport>
  </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>
    <GetDetailedEngagementReportResponse xmlns="http://ea-api.litmus.com/">
      <GetDetailedEngagementReportResult>
        <Less2SecCount>int</Less2SecCount>
        <Less4SecCount>int</Less4SecCount>
        <Less6SecCount>int</Less6SecCount>
        <Less8SecCount>int</Less8SecCount>
        <Less10SecCount>int</Less10SecCount>
        <Less12SecCount>int</Less12SecCount>
        <Less14SecCount>int</Less14SecCount>
        <Less16SecCount>int</Less16SecCount>
        <Less18SecCount>int</Less18SecCount>
        <Over18SecCount>int</Over18SecCount>
        <Less2SecPercentage>int</Less2SecPercentage>
        <Less4SecPercentage>int</Less4SecPercentage>
        <Less6SecPercentage>int</Less6SecPercentage>
        <Less8SecPercentage>int</Less8SecPercentage>
        <Less10SecPercentage>int</Less10SecPercentage>
        <Less12SecPercentage>int</Less12SecPercentage>
        <Less14SecPercentage>int</Less14SecPercentage>
        <Less16SecPercentage>int</Less16SecPercentage>
        <Less18SecPercentage>int</Less18SecPercentage>
        <Over18SecPercentage>int</Over18SecPercentage>
        <Less2SecAvgPercentage>int</Less2SecAvgPercentage>
        <Less4SecAvgPercentage>int</Less4SecAvgPercentage>
        <Less6SecAvgPercentage>int</Less6SecAvgPercentage>
        <Less8SecAvgPercentage>int</Less8SecAvgPercentage>
        <Less10SecAvgPercentage>int</Less10SecAvgPercentage>
        <Less12SecAvgPercentage>int</Less12SecAvgPercentage>
        <Less14SecAvgPercentage>int</Less14SecAvgPercentage>
        <Less16SecAvgPercentage>int</Less16SecAvgPercentage>
        <Less18SecAvgPercentage>int</Less18SecAvgPercentage>
        <Over18SecAvgPercentage>int</Over18SecAvgPercentage>
        <Less2SecAvgCount>int</Less2SecAvgCount>
        <Less4SecAvgCount>int</Less4SecAvgCount>
        <Less6SecAvgCount>int</Less6SecAvgCount>
        <Less8SecAvgCount>int</Less8SecAvgCount>
        <Less10SecAvgCount>int</Less10SecAvgCount>
        <Less12SecAvgCount>int</Less12SecAvgCount>
        <Less14SecAvgCount>int</Less14SecAvgCount>
        <Less16SecAvgCount>int</Less16SecAvgCount>
        <Less18SecAvgCount>int</Less18SecAvgCount>
        <Over18SecAvgCount>int</Over18SecAvgCount>
      </GetDetailedEngagementReportResult>
    </GetDetailedEngagementReportResponse>
  </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>
    <GetDetailedEngagementReport xmlns="http://ea-api.litmus.com/">
      <user>string</user>
      <password>string</password>
      <campaignGuid>string</campaignGuid>
    </GetDetailedEngagementReport>
  </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>
    <GetDetailedEngagementReportResponse xmlns="http://ea-api.litmus.com/">
      <GetDetailedEngagementReportResult>
        <Less2SecCount>int</Less2SecCount>
        <Less4SecCount>int</Less4SecCount>
        <Less6SecCount>int</Less6SecCount>
        <Less8SecCount>int</Less8SecCount>
        <Less10SecCount>int</Less10SecCount>
        <Less12SecCount>int</Less12SecCount>
        <Less14SecCount>int</Less14SecCount>
        <Less16SecCount>int</Less16SecCount>
        <Less18SecCount>int</Less18SecCount>
        <Over18SecCount>int</Over18SecCount>
        <Less2SecPercentage>int</Less2SecPercentage>
        <Less4SecPercentage>int</Less4SecPercentage>
        <Less6SecPercentage>int</Less6SecPercentage>
        <Less8SecPercentage>int</Less8SecPercentage>
        <Less10SecPercentage>int</Less10SecPercentage>
        <Less12SecPercentage>int</Less12SecPercentage>
        <Less14SecPercentage>int</Less14SecPercentage>
        <Less16SecPercentage>int</Less16SecPercentage>
        <Less18SecPercentage>int</Less18SecPercentage>
        <Over18SecPercentage>int</Over18SecPercentage>
        <Less2SecAvgPercentage>int</Less2SecAvgPercentage>
        <Less4SecAvgPercentage>int</Less4SecAvgPercentage>
        <Less6SecAvgPercentage>int</Less6SecAvgPercentage>
        <Less8SecAvgPercentage>int</Less8SecAvgPercentage>
        <Less10SecAvgPercentage>int</Less10SecAvgPercentage>
        <Less12SecAvgPercentage>int</Less12SecAvgPercentage>
        <Less14SecAvgPercentage>int</Less14SecAvgPercentage>
        <Less16SecAvgPercentage>int</Less16SecAvgPercentage>
        <Less18SecAvgPercentage>int</Less18SecAvgPercentage>
        <Over18SecAvgPercentage>int</Over18SecAvgPercentage>
        <Less2SecAvgCount>int</Less2SecAvgCount>
        <Less4SecAvgCount>int</Less4SecAvgCount>
        <Less6SecAvgCount>int</Less6SecAvgCount>
        <Less8SecAvgCount>int</Less8SecAvgCount>
        <Less10SecAvgCount>int</Less10SecAvgCount>
        <Less12SecAvgCount>int</Less12SecAvgCount>
        <Less14SecAvgCount>int</Less14SecAvgCount>
        <Less16SecAvgCount>int</Less16SecAvgCount>
        <Less18SecAvgCount>int</Less18SecAvgCount>
        <Over18SecAvgCount>int</Over18SecAvgCount>
      </GetDetailedEngagementReportResult>
    </GetDetailedEngagementReportResponse>
  </soap12:Body>
</soap12:Envelope>