[Reports] Conversions (V10) - Admin

Ron Torres

Modified on: Fri, 18 Sep, 2015 at 10:38 AM

NOTE: The conversion_type node, you will see these available options: Click, Impression, Lead Submission, Third Party, Manual Insertion. Which is how the Conversion originated. In addition to these changes, we have added the Price Format. Syntax = Conversion Type - Price Format.

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

Parameter Summary:

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

start_date / DATETIME = Report Start Date [MM/DD/YYYY HH:MM:SS]

end_date / DATETIME = Report End Date [MM/DD/YYYY HH:MM:SS]

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

start_date - ID

end_date - 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/Conversions?api_key=dNJFmId9rI&start_date=7/30/13&end_date=7/31/13&affiliate_id=0&advertiser_id=0&offer_id=1000732&campaign_id=0&creative_id=0&include_tests=TRUE&start_at_row=0&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>1</row_count>
  <conversions>
    <conversion>
      <conversion_id>357971</conversion_id>
      <visitor_id>3976844</visitor_id>
      <request_session_id>3460755</request_session_id>
      <click_request_session_id xsi:nil="true"/>
      <click_id xsi:nil="true"/>
      <conversion_date>2013-07-30T16:39:06.4</conversion_date>
      <last_updated>2013-09-30T18:00:00.427</last_updated>
      <click_date xsi:nil="true"/>
      <affiliate>
        <affiliate_id xmlns="API:id_name_store">5360</affiliate_id>
        <affiliate_name xmlns="API:id_name_store">CPA Ruskie</affiliate_name>
      </affiliate>
      <advertiser>
        <advertiser_id xmlns="API:id_name_store">61</advertiser_id>
        <advertiser_name xmlns="API:id_name_store">Money Minus Pets</advertiser_name>
      </advertiser>
      <offer>
        <offer_id xmlns="API:id_name_store">1000732</offer_id>
        <offer_name xmlns="API:id_name_store">Cake Fixed</offer_name>
      </offer>
      <offer_contract>
        <offer_contract_id xmlns="API:id_name_store">1629</offer_contract_id>
        <offer_contract_name xmlns="API:id_name_store"/>
      </offer_contract>
      <campaign_id>6330</campaign_id>
      <creative>
        <creative_id xmlns="API:id_name_store">1131617</creative_id>
        <creative_name xmlns="API:id_name_store">1131617</creative_name>
      </creative>
      <sub_id_1/>
      <sub_id_2/>
      <sub_id_3/>
      <sub_id_4/>
      <sub_id_5/>
      <conversion_type>Click - Fixed</conversion_type>
      <paid>
        <currency_id>1</currency_id>
        <amount>16.6666</amount>
        <formatted_amount>$16.67</formatted_amount>
      </paid>
      <received>
        <currency_id>1</currency_id>
        <amount>0.0000</amount>
        <formatted_amount>$0.00</formatted_amount>
      </received>
      <step_reached>1</step_reached>
      <pixel_dropped>false</pixel_dropped>
      <suppressed>false</suppressed>
      <returned>false</returned>
      <test>false</test>
      <transaction_id>test</transaction_id>
      <conversion_ip_address>65.60.119.2</conversion_ip_address>
      <conversion_referrer_url/>
      <conversion_user_agent>Mozilla/5.0 (Windows NT 6.1) AppleWebKit/536.11 (KHTML, like Gecko) Chrome/20.0.1132.57 Safari/536.11</conversion_user_agent>
      <campaign_type>
        <campaign_type_id xmlns="API:id_name_store">1</campaign_type_id>
        <campaign_type_name xmlns="API:id_name_store">Standard</campaign_type_name>
      </campaign_type>
      <note>Returns</note>
    </conversion>
  </conversions>
</conversion_report_response>

Related Articles