REPORTS ConversionExport API Version 3 (DEPRECATED)

Ron Torres

Modified on: Tue, 15 Sep, 2015 at 1:30 PM

REPORTS ConversionExport V3

Updated on 2014-04-04
Current Version: Version 3
Deprecated Version: V1, V2
Requests Allowed: GET/POST/SOAP

Summary:

Returns an array of conversions and its properties.

Resource/WSDL Page:

http://yourdomainhere/api/3/reports.asmx?op=ConversionExport

Parameters

api_key Required Type: STRING Length (Max/Min): 50	As an administrator to your CAKE instance, you can obtain your API key in one of two ways. 1.) From within your instance >> setup tab >> permissions. 2.) Using the GET GetAPIKey Example Values: dNJFmId9rIZZrs
start_date Required Type: DATE Length (Max/Min): NA	Allowed formats: "YYYY-mm-dd","dd-mm-YYYY"
end_date Required Type: DATE Length (Max/Min): NA	Allowed formats: "YYYY-mm-dd","dd-mm-YYYY"
affiliate_id Optional Type: INT Length (Max/Min): NA	The Affiliate ID can be collected from the UI in the affiliate Card. Example Values: 7894
offer_id Optional Type: INT Length (Max/Min): NA	This is the identifier for a unique Offer. This can be found on any Offer card. Example Values: 1234
include_tests Required Type: BOOL Length (Max/Min): NA	The following values can only be used for this parameter (TRUE or FALSE). Example Values: TRUE

**Note all optional parameters still need to be passed through in the actual call. These parameters do not need a value (therefore you can use a null value).

Example Request

GET	https://demo.cakemarketing.com/api/3/reports.asmx/ConversionExport?api_key=oLrOexHsTsdTLb5GKJA0WUw1Lz22Ja1B&start_date=03-01-2014&end_date=03-10-2014&affiliate_id=0&offer_id=0&include_tests=TRUE

Sample XML Response:

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfConversion xmlns="http://cakemarketing.com/api/3/">
  <Conversion>
    <conversion_id>string</conversion_id>
    <visitor_id>int</visitor_id>
    <request_session_id>int</request_session_id>
    <click_id>int</click_id>
    <conversion_date>dateTime</conversion_date>
    <affiliate_id>int</affiliate_id>
    <affiliate_name>string</affiliate_name>
    <offer_id>int</offer_id>
    <offer_name>string</offer_name>
    <advertiser_id>int</advertiser_id>
    <advertiser_name>string</advertiser_name>
    <campaign_id>int</campaign_id>
    <creative_id>int</creative_id>
    <creative_name>string</creative_name>
    <subid_1>string</subid_1>
    <subid_2>string</subid_2>
    <subid_3>string</subid_3>
    <subid_4>string</subid_4>
    <subid_5>string</subid_5>
    <conversion_type>string</conversion_type>
    <price_paid>decimal</price_paid>
    <price_received>decimal</price_received>
    <pixel_dropped>boolean</pixel_dropped>
    <throttled>boolean</throttled>
    <returned>boolean</returned>
    <test>boolean</test>
    <transaction_id>string</transaction_id>
    <ip_address>string</ip_address>
    <referrer_url>string</referrer_url>
    <disposition>string</disposition>
    <note>string</note>
  </Conversion>
  <Conversion>
    <conversion_id>string</conversion_id>
    <visitor_id>int</visitor_id>
    <request_session_id>int</request_session_id>
    <click_id>int</click_id>
    <conversion_date>dateTime</conversion_date>
    <affiliate_id>int</affiliate_id>
    <affiliate_name>string</affiliate_name>
    <offer_id>int</offer_id>
    <offer_name>string</offer_name>
    <advertiser_id>int</advertiser_id>
    <advertiser_name>string</advertiser_name>
    <campaign_id>int</campaign_id>
    <creative_id>int</creative_id>
    <creative_name>string</creative_name>
    <subid_1>string</subid_1>
    <subid_2>string</subid_2>
    <subid_3>string</subid_3>
    <subid_4>string</subid_4>
    <subid_5>string</subid_5>
    <conversion_type>string</conversion_type>
    <price_paid>decimal</price_paid>
    <price_received>decimal</price_received>
    <pixel_dropped>boolean</pixel_dropped>
    <throttled>boolean</throttled>
    <returned>boolean</returned>
    <test>boolean</test>
    <transaction_id>string</transaction_id>
    <ip_address>string</ip_address>
    <referrer_url>string</referrer_url>
    <disposition>string</disposition>
    <note>string</note>
  </Conversion>
</ArrayOfConversion>

Example Error Messages:

Error Message	Likely Cause
Invalid API Key	API Key does not exist or is expired.