NOTICE: THIS VERSION OF THE API HAS BEEN DEPRECATED. IT WILL CONTINUE TO WORK INDEFINITELY, BUT HAS INCREASED FUNCTIONALITY IN NEWER VERSIONS.
WSDL Page: http://<your_domain_here>/api/7/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/7/reports.asmx/Conversions?api_key=dNJFmId9rI&start_date=01/01/2012+12:00:00&end_date=01/01/2012+17:00:00&affiliate_id=4410&advertiser_id=0&offer_id=0&campaign_id=0&creative_id=0&include_tests=TRUE&start_at_row=1&row_limit=5&sort_field=conversion_date&sort_descending=FALSE
Sample XML Response:
<conversion_report_response>
<success>true</success>
<row_count>1</row_count>
<conversions>
<conversion>
<conversion_id>4CD4578B</conversion_id>
<visitor_id>1282015</visitor_id>
<request_session_id>293286</request_session_id>
<click_request_session_id>293286</click_request_session_id>
<click_id>306095</click_id>
<conversion_date>2012-01-01T15:19:56.02</conversion_date>
<last_updated>2013-01-23T20:53:56.547</last_updated>
<click_date>2012-01-01T15:18:42.17</click_date>
<affiliate>
<affiliate_id>4410</affiliate_id>
<affiliate_name>Affilate 4410</affiliate_name>
</affiliate>
<advertiser>
<advertiser_id>1</advertiser_id>
<advertiser_name>Rename Advertiser</advertiser_name>
</advertiser>
<offer>
<offer_id>163</offer_id>
<offer_name>WALMART Gift Card - UK</offer_name>
</offer>
<campaign_id>1010</campaign_id>
<creative>
<creative_id>326</creative_id>
<creative_name>326 - Best Creative</creative_name>
</creative>
<sub_id_1>462</sub_id_1>
<sub_id_2>45441_</sub_id_2>
<sub_id_3/>
<sub_id_4/>
<sub_id_5/>
<conversion_type>CPA</conversion_type>
<paid>
<currency_id>2</currency_id>
<amount>15.0000</amount>
<formatted_amount>€15.00</formatted_amount>
</paid>
<received>
<currency_id>2</currency_id>
<amount>21.7500</amount>
<formatted_amount>€21.75</formatted_amount>
</received>
<step_reached>1</step_reached>
<pixel_dropped>true</pixel_dropped>
<suppressed>false</suppressed>
<returned>false</returned>
<test>false</test>
<transaction_id/>
<conversion_ip_address>168.192.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 8.0; Windows NT 6.0; WOW64; Trident/4.0; SLCC1; .NET CLR 2.0.50727; Media Center PC 5.0; eSobiSubscriber 2.0.4.16; .NET CLR 3.5.30729; .NET CLR 3.0.30618)</conversion_user_agent>
<click_user_agent>Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.0; WOW64; Trident/4.0; SLCC1; .NET CLR 2.0.50727; Media Center PC 5.0; eSobiSubscriber 2.0.4.16; .NET CLR 3.5.30729; .NET CLR 3.0.30618)</click_user_agent>
<country>
<country_code>US</country_code>
</country>
<current_disposition>
<disposition_id>53</disposition_id>
<disposition_name>Generic Voicemail</disposition_name>
<disposition_type>
<disposition_type_id>3</disposition_type_id>
<disposition_type_name>Approved</disposition_type_name>
</disposition_type>
<contact>John Doe</contact>
<disposition_date>2012-01-04T10:34:40.897</disposition_date>
</current_disposition>
<campaign_type>
<campaign_type_id>1</campaign_type_id>
<campaign_type_name>Standard</campaign_type_name>
</campaign_type>
<note/>
</conversion>
</conversions>
</conversion_report_response>