If you have any question left, please drop a note with the discussion link of this page.

Reports Methods

From Wiki.zanox.com

Jump to: navigation, search

This SOAP methods let you retrieve (statistical) information on your generated leads, sales and commisions. Please note that all report functions currently work with CEST (GMT+2) or CET (GMT+1).

Information on sales and leads can only be retrieved by these methods.

Contents

GetSales

Example Request

Edit 07.04.09

The optional 'date' has the format: 2009-04-06T00:00:00+02:00

Also see http://wiki.zanox.com/en/PHP_SOAP_Account_Browser


 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://api.zanox.com/namespace/2008-05-21/">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:GetSales>
         <!--Optional:-->
         <ns:saleId>?</ns:saleId>
         <!--Optional:-->
         <ns:date>?</ns:date>
         <!--Optional:-->
         <ns:modifieddate>?</ns:modifieddate>
         <!--Optional:-->
         <ns:clickdate>?</ns:clickdate>
         <ns:page>0</ns:page>
         <ns:items>3</ns:items>
         <ns:applicationId>12345678987654321</ns:applicationId>
         <ns:timestamp>2008-09-15T14:08:35.000Z</ns:timestamp>
         <ns:signature>a8twC6SrQr/1ayo+/8Mdm41lCUo=</ns:signature>
      </ns:GetSales>
   </soapenv:Body>
</soapenv:Envelope>
 

Example Response

Edit 8.04.09

The available 'status' codes are: OPEN, APPROVED, CONFIRMED, REJECTED

 
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
   <env:Header/>
   <env:Body>
      <GetSalesResponse xmlns="http://api.zanox.com/namespace/2008-05-21/">
         <return>
            <page>0</page>
            <items>1</items>
            <total>1</total>
            <reportsResult>
               <saleItem id="A0CEF748-4030-4A0A-A7BC-D36E4B7C7B95">
                  <status>OPEN</status>
                  <date>2008-09-04T17:29:22.150+02:00</date>
                  <modifieddate>2008-09-04T17:29:50.907+02:00</modifieddate>
                  <adspace id="784330">a-loha.de</adspace>
                  <admedia id="8237">OTTO Textlink_Artikel_1</admedia>
                  <program id="418">OTTO</program>
                  <amount>0.0</amount>
                  <commission>0.0</commission>
                  <currency>EUR</currency>
               </saleItem>
            </reportsResult>
         </return>
      </GetSalesResponse>
   </env:Body>
</env:Envelope>
 

Explanation of Response Items

Explanation of the response items for getSales


GetLeads

Example Request

 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://api.zanox.com/namespace/2008-05-21/">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:GetLeads>
         <!--Optional:-->
         <ns:leadId>?</ns:leadId>
         <!--Optional:-->
         <ns:date>?</ns:date>
         <!--Optional:-->
         <ns:modifieddate>?</ns:modifieddate>
         <!--Optional:-->
         <ns:clickdate>?</ns:clickdate>
         <ns:page>?</ns:page>
         <ns:items>?</ns:items>
         <!--Optional:-->
         <ns:applicationId>12345678987654321</ns:applicationId>
         <ns:timestamp>2008-09-15T14:24:20.000Z</ns:timestamp>
         <ns:signature>8WYSV0pG84dyiLIVdRKgNylnE40=</ns:signature>
      </ns:GetLeads>
   </soapenv:Body>
</soapenv:Envelope>
 

Example Response

 
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
   <env:Header/>
   <env:Body>
      <GetLeadsResponse xmlns="http://api.zanox.com/namespace/2008-05-21/">
         <return>
            <page>0</page>
            <items>1</items>
            <total>1</total>
            <reportsResult>
               <leadItem id="A0CEF748-4030-4A0A-A7BC-D36E4B7C7B95">
                  <status>OPEN</status>
                  <date>2008-09-04T17:29:22.150+02:00</date>
                  <modifieddate>2008-09-04T17:29:50.907+02:00</modifieddate>
                  <adspace id="784330">a-loha.de</adspace>
                  <admedia id="8237">OTTO Textlink_Artikel_1</admedia>
                  <program id="418">OTTO</program>
                  <amount>0.0</amount>
                  <commission>0.0</commission>
                  <currency>EUR</currency>
               </leadItem>
            </reportsResult>
         </return>
      </GetLeadsResponse>
   </env:Body>
</env:Envelope>
 

Explanation of Response Items

Explanation of the response items for getLeads

Personal tools