[Reports] ConversionChanges (V10) - Admin

Ron Torres

Modified on: Fri, 18 Sep, 2015 at 6:08 PM

WSDL Page: http://<your_domain_here>/api/10/reports.asmx?op=ConversionChanges

Parameter Summary:

api_key / STRING = Admin API Key {See get.asmx > GetAPIKey}

changes_since / DATETIME = Include Changes Since [MM/DD/YYYY HH:MM:SS]

include_new_conversions / BOOL = Include New Conversions? ["TRUE" = Include New Conversions, "FALSE" = Include ONLY Conversion Changes]

affiliate_id / INT = Affiliate ID ["0" = ALL Affiliates] {See export.asmx > Affiliates}

advertiser_id / INT = Advertiser ID ["0" = ALL Advertisers] {See export.asmx > Advertisers}

offer_id / INT = Offer ID ["0" = ALL Offers] {See export.asmx > Offers}

campaign_id / INT = Campaign ID ["0" = ALL Campaigns] {See export.asmx > Campaigns}

creative_id / INT = Creative ID ["0" = ALL Creatives] {See export.asmx > Creatives}

include_tests / BOOL = Include Test Clicks? ["TRUE", "FALSE"]

start_at_row / INT = Starting Row Number [Usually "1", unless doing incremental API Calls]

row_limit / INT = Maximum Rows Returned ["0" = ALL Rows, "100000" = Maximum]

sort_field / STRING = Sort Field ["conversion_id", "visitor_id", "request_session_id", "click_id", "conversion_date", "transaction_id", "last_updated"]

sort_descending / BOOL = Sort Descending? ["TRUE", "FALSE"]

Parameter Types:

api_key - ID

changes_since - ID

include_new_conversions - ID

affiliate_id - ID

advertiser_id - ID

offer_id - ID

campaign_id - ID

creative_id - ID

include_tests - ID

start_at_row - ID

row_limit - ID

sort_field - ID

sort_descending - ID

Sample GET Call:

http://demo.cakemarketing.com/api/10/reports.asmx/ConversionChanges?api_key=dNJFmId9rI&changes_since=01/01/2012+12:00:00&include_new_conversions=TRUE&affiliate_id=4410&advertiser_id=0&offer_id=0&campaign_id=0&creative_id=0&include_tests=TRUE&start_at_row=1&row_limit=1&sort_field=conversion_date&sort_descending=FALSE

Sample XML Response:

<conversion_report_response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://cakemarketing.com/api/10/">
   <success>true</success>
   <row_count>1789</row_count>
   <conversions>
      <conversion>
         <conversion_id>235BACB4</conversion_id>
         <visitor_id>1146146</visitor_id>
         <request_session_id>151631</request_session_id>
         <click_request_session_id xsi:nil="true"/>
         <click_id>158915</click_id>
         <conversion_date>2011-12-09T06:02:03.577</conversion_date>
         <last_updated>2013-01-23T20:53:56.547</last_updated>
         <click_date>2011-12-09T06:01:03.453</click_date>
         <affiliate>
            <affiliate_id xmlns="API:id_name_store">4410</affiliate_id>
            <affiliate_name xmlns="API:id_name_store">Affilate 4410</affiliate_name>
         </affiliate>
         <advertiser>
            <advertiser_id xmlns="API:id_name_store">1</advertiser_id>
            <advertiser_name xmlns="API:id_name_store">Rename Advertiser</advertiser_name>
         </advertiser>
         <offer>
            <offer_id xmlns="API:id_name_store">163</offer_id>
            <offer_name xmlns="API:id_name_store">WALMART Gift Card - UK</offer_name>
         </offer>
         <offer_contract>
            <offer_contract_id xmlns="API:id_name_store">294</offer_contract_id>
            <offer_contract_name xmlns="API:id_name_store">Offer Contract 294</offer_contract_name>
         </offer_contract>
         <campaign_id>1010</campaign_id>
         <creative>
            <creative_id xmlns="API:id_name_store">326</creative_id>
            <creative_name xmlns="API:id_name_store">326 - Best Creative</creative_name>
         </creative>
         <sub_id_1/>
         <sub_id_2/>
         <sub_id_3/>
         <sub_id_4/>
         <sub_id_5/>
         <conversion_type>CPA</conversion_type>
         <paid>
            <currency_id>2</currency_id>
            <amount>0.0000</amount>
            <formatted_amount>€0.00</formatted_amount>
         </paid>
         <received>
            <currency_id>2</currency_id>
            <amount>2.7500</amount>
            <formatted_amount>€2.75</formatted_amount>
         </received>
         <step_reached>1</step_reached>
         <pixel_dropped>false</pixel_dropped>
         <suppressed>false</suppressed>
         <returned>false</returned>
         <test>false</test>
         <transaction_id/>
         <conversion_ip_address>192.168.1.1</conversion_ip_address>
         <click_ip_address>192.168.1.1</click_ip_address>
         <conversion_referrer_url/>
         <conversion_user_agent>
            Mozilla/4.0 (compatible; MSIE 7.0; AOL 9.0; Windows NT 5.1; FunWebProducts; .NET CLR 1.1.4322)
         </conversion_user_agent>
         <click_user_agent>
            Mozilla/4.0 (compatible; MSIE 7.0; AOL 9.0; Windows NT 5.1; FunWebProducts; .NET CLR 1.1.4322)
         </click_user_agent>
         <country>
            <country_code xmlns="API:id_name_store">US</country_code>
         </country>
         <current_disposition>
            <disposition_id>53</disposition_id>
            <disposition_name>Generic Voicemail</disposition_name>
            <disposition_type>
               <disposition_type_id xmlns="API:id_name_store">3</disposition_type_id>
               <disposition_type_name xmlns="API:id_name_store">Approved</disposition_type_name>
            </disposition_type>
            <contact>John Doe</contact>
            <disposition_date>2011-12-09T10:36:09.16</disposition_date>
         </current_disposition>
         <note/>
      </conversion>
   </conversions>
</conversion_report_response>

Related Articles