Reporting API

Get In-Depth Metrics of Your Email Campaigns

BounceDescriptions()



<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>
    <BounceDescriptions xmlns="http://api.directiq.com/" />
  </soap:Body>
</soap:Envelope>


<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>
    <BounceDescriptionsResponse xmlns="http://api.directiq.com/">
      <BounceDescriptionsResult>
        <system_bounce_type>
          <bounce_id>short</bounce_id>
          <bounce_name>string</bounce_name>
        </system_bounce_type>
        <system_bounce_type>
          <bounce_id>short</bounce_id>
          <bounce_name>string</bounce_name>
        </system_bounce_type>
      </BounceDescriptionsResult>
    </BounceDescriptionsResponse>
  </soap:Body>
</soap:Envelope>

GetCampaignBounces()



<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>
    <GetCampaignBounces xmlns="http://api.directiq.com/">
      <apikey>string</apikey>
      <campaignID>int</campaignID>
    </GetCampaignBounces>
  </soap:Body>
</soap:Envelope>


<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>
    <GetCampaignBouncesResponse xmlns="http://api.directiq.com/">
      <GetCampaignBouncesResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedBounces>
          <BouncesItem>
            <contactID>int</contactID>
            <reason>string</reason>
            <bounceDate>dateTime</bounceDate>
            <bounceType>int</bounceType>
          </BouncesItem>
          <BouncesItem>
            <contactID>int</contactID>
            <reason>string</reason>
            <bounceDate>dateTime</bounceDate>
            <bounceType>int</bounceType>
          </BouncesItem>
        </returnedBounces>
      </GetCampaignBouncesResult>
    </GetCampaignBouncesResponse>
  </soap:Body>
</soap:Envelope>

GetCampaignClicks()



<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>
    <GetCampaignClicks xmlns="http://api.directiq.com/">
      <apikey>string</apikey>
      <campaignID>int</campaignID>
    </GetCampaignClicks>
  </soap:Body>
</soap:Envelope>


<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>
    <GetCampaignClicksResponse xmlns="http://api.directiq.com/">
      <GetCampaignClicksResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedClicks>
          <Clicksitem>
            <contactID>int</contactID>
            <link>string</link>
            <clickDate>dateTime</clickDate>
            <countryName>string</countryName>
            <city>string</city>
          </Clicksitem>
          <Clicksitem>
            <contactID>int</contactID>
            <link>string</link>
            <clickDate>dateTime</clickDate>
            <countryName>string</countryName>
            <city>string</city>
          </Clicksitem>
        </returnedClicks>
      </GetCampaignClicksResult>
    </GetCampaignClicksResponse>
  </soap:Body>
</soap:Envelope>

GetCampaignReads()



<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>
    <GetCampaignReads xmlns="http://api.directiq.com/">
      <apikey>string</apikey>
      <campaignID>int</campaignID>
    </GetCampaignReads>
  </soap:Body>
</soap:Envelope>


<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>
    <GetCampaignReadsResponse xmlns="http://api.directiq.com/">
      <GetCampaignReadsResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedReads>
          <ReadsItem>
            <contactID>int</contactID>
            <readDate>dateTime</readDate>
            <countryName>string</countryName>
            <city>string</city>
          </ReadsItem>
          <ReadsItem>
            <contactID>int</contactID>
            <readDate>dateTime</readDate>
            <countryName>string</countryName>
            <city>string</city>
          </ReadsItem>
        </returnedReads>
      </GetCampaignReadsResult>
    </GetCampaignReadsResponse>
  </soap:Body>
</soap:Envelope>

GetCampaignSpamComplaints()



<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>
    <GetCampaignSpamComplaints xmlns="http://api.directiq.com/">
      <apikey>string</apikey>
      <campaignID>int</campaignID>
    </GetCampaignSpamComplaints>
  </soap:Body>
</soap:Envelope>


<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>
    <GetCampaignSpamComplaintsResponse xmlns="http://api.directiq.com/">
      <GetCampaignSpamComplaintsResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedSpamComplaints>
          <SpamComplaintsItem>
            <contactID>int</contactID>
            <spamComplaintDate>dateTime</spamComplaintDate>
          </SpamComplaintsItem>
          <SpamComplaintsItem>
            <contactID>int</contactID>
            <spamComplaintDate>dateTime</spamComplaintDate>
          </SpamComplaintsItem>
        </returnedSpamComplaints>
      </GetCampaignSpamComplaintsResult>
    </GetCampaignSpamComplaintsResponse>
  </soap:Body>
</soap:Envelope>

GetCampaignStats()



<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>
    <GetCampaignStats xmlns="http://api.directiq.com/">
      <apikey>string</apikey>
      <campaignID>int</campaignID>
    </GetCampaignStats>
  </soap:Body>
</soap:Envelope>

<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>
    <GetCampaignStatsResponse xmlns="http://api.directiq.com/">
      <GetCampaignStatsResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedData>
          <recipients>int</recipients>
          <delivers>int</delivers>
          <bounces>int</bounces>
          <reads>int</reads>
          <clicks>int</clicks>
          <spams>int</spams>
          <unsubscribes>int</unsubscribes>
        </returnedData>
      </GetCampaignStatsResult>
    </GetCampaignStatsResponse>
  </soap:Body>
</soap:Envelope>

GetCampaignUnsubscribes()



<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>
    <GetCampaignUnsubscribes xmlns="http://api.directiq.com/">
      <apikey>string</apikey>
      <campaignID>int</campaignID>
    </GetCampaignUnsubscribes>
  </soap:Body>
</soap:Envelope>

<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>
    <GetCampaignUnsubscribesResponse xmlns="http://api.directiq.com/">
      <GetCampaignUnsubscribesResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedUnsubscribes>
          <UnsubscribesItem>
            <contactID>int</contactID>
            <unsubscribeDate>dateTime</unsubscribeDate>
          </UnsubscribesItem>
          <UnsubscribesItem>
            <contactID>int</contactID>
            <unsubscribeDate>dateTime</unsubscribeDate>
          </UnsubscribesItem>
        </returnedUnsubscribes>
      </GetCampaignUnsubscribesResult>
    </GetCampaignUnsubscribesResponse>
  </soap:Body>
</soap:Envelope>