CAKE Help & Support

REPORTS ConversionChanges API Version 5 (DEPRECATED)

Modified on: Wed, 9 Sep, 2015 at 12:10 PM


REPORTS ConversionChanges API

Updated on 2014-04-02
Current Version: Version 5
Latest Version: Version 10
Deprecated Version: N/A
Requests Allowed: GET/SOAP

 

Summary:

This API will return a list of Conversions that have changed within a specific time period.  This information can also be found in the Conversion Report.

 

Resource/WSDL Page:

http://yourdomainhere/api/5/reports.asmx?op=ConversionChanges

 

Parameters

api_key
Required
Type: STRING
Length (Max/Min): 50

This api_key will provide you with the ability to export Campaigns for your instance. You can obtain this api_key from within CAKE >> Setup >> Permissions in the API Key list.  

Must be a valid API key (exisiting and NOT expired)

Example Values: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh

changes_since
Required
Type: DATE
Length (Max/Min): N/A

This date will filter all conversions from a specific date.

Allowed formats: "YYYY-mm-dd","dd-mm-YYYY"

Example Values: 2014-02-15

include_new_conversions
Required
Type: BOOL
Length (Max/Min): N/A

Drives whether only changed conversions are returned or new ones as well.

Example Values: Y

affiliate_id
Required
Type: INTEGER
Length (Max/Min): N/A

This is the identifier for a unique Affiliate.  This can be found on any Affiliate card.

If passing anything <= 0 the result will include all affiliates.

 

Example Values: 1234

advertiser_id
Required
Type: INTEGER
Length (Max/Min): N/A

This is the identifier for a unique Advertiser.  This can be found on any Advertiser card.

If passing anything <= 0 the result will include all advertisers.

Example Values: 1234

offer_id
Required
Type: INTEGER
Length (Max/Min): N/A

This is the identifier for a unique Offer.  This can be found on any Offer card.

If passing anything <= 0 the result will include all offers.

Example Values: 1234

campaign_id
Required
Type: INTEGER
Length (Max/Min): N/A

This is the identifier for a unique Campaign.  This can be found on any Campaign card.

If passing anything <= 0 the result will include all campaigns.

 

Example Values: 1234

creative_id
Required
Type: INTEGER
Length (Max/Min): N/A

This is the identifier for a unique Creative.  This can be found on any Creative card.

If passing anything <= 0 the result will include all creatives.

Example Values: 1234

include_tests
Required
Type: BOOL
Length (Max/Min): N/A

Drives whether test conversions are returned.

Example Values: Y

start_at_row
Required
Type: INTEGER
Length (Max/Min): N/A

Must pass at least 0 as value, which means start at the beginning of the data set.

Example Values: 3

row_limit
Required
Type: INTEGER
Length (Max/Min): N/A

Must pass at least 0 as value, which means no limit.

Example Values: 3

sort_field
Required
Type: INTEGER
Length (Max/Min): N/A

Accepts "conversion_id", "visitor_id", "request_session_id", "click_id", "conversion_date", "transaction_id" or "last_updated"

Example Values: 3

sort_descending

Required
Type: BOOL
Length (Max/Min): N/A

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

http://demo.cakemarketing.com/api/5/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=5&sort_field=conversion_date
&sort_descending=FALSE

 

Sample XML Response:

This XML file does not appear to have any style information associated with it. The document tree is shown below.
 
<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/5/">
<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_id xsi:nil="true"/>
<conversion_date>2011-12-09T06:02:03.577</conversion_date>
<last_updated>2013-01-23T20:53:56.547</last_updated>
<click_date xsi:nil="true"/>
<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>
<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>Click</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>
<country/>
<conversion_referrer_url/>
<click_referrer_url/>
<conversion_user_agent>
Mozilla/4.0%20(compatible;%20MSIE%207.0;%20AOL%209.0;%20Windows%20NT%205.1;%20FunWebProducts;%20.NET%20CLR%201.1.4322)
</conversion_user_agent>
<click_user_agent/>
<disposition>
<approved>true</approved>
<disposition_name>Generic Voicemail</disposition_name>
<contact>John Doe</contact>
<disposition_date>2011-12-09T10:36:09.16</disposition_date>
</disposition>
<note/>
</conversion>
<conversion>
<conversion_id>09F0DD22</conversion_id>
<visitor_id>1146467</visitor_id>
<request_session_id>151974</request_session_id>
<click_id xsi:nil="true"/>
<conversion_date>2011-12-09T06:56:42.297</conversion_date>
<last_updated>2013-01-23T20:53:56.547</last_updated>
<click_date xsi:nil="true"/>
<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>
<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>Click</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.5000</amount>
<formatted_amount>€2.50</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>
<country/>
<conversion_referrer_url/>
<click_referrer_url/>
<conversion_user_agent>
Mozilla/4.0%20(compatible;%20MSIE%207.0;%20Windows%20NT%206.0;%20SLCC1;%20.NET%20CLR%202.0.50727;%20Media%20Center%20PC%205.0;%20.NET%20CLR%203.5.30729;%20.NET%20CLR%203.0.30618)
</conversion_user_agent>
<click_user_agent/>
<disposition>
<approved>true</approved>
<disposition_name>Verified filled out form and qualifies for product</disposition_name>
<contact>John Doe</contact>
<disposition_date>2011-12-09T10:55:14.397</disposition_date>
</disposition>
<note/>
</conversion>
<conversion>
<conversion_id>F1D51A1D</conversion_id>
<visitor_id>1146520</visitor_id>
<request_session_id>152027</request_session_id>
<click_id xsi:nil="true"/>
<conversion_date>2011-12-09T07:08:58.497</conversion_date>
<last_updated>2013-01-23T20:53:56.547</last_updated>
<click_date xsi:nil="true"/>
<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>
<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>Click</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>24.0000</amount>
<formatted_amount>€24.00</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>
<country/>
<conversion_referrer_url/>
<click_referrer_url/>
<conversion_user_agent>
Mozilla/4.0%20(compatible;%20MSIE%207.0;%20AOL%209.1;%20AOLBuild%204334.34;%20Windows%20NT%206.0;%20GTB6;%20SLCC1;%20.NET%20CLR%202.0.50727;%20Media%20Center%20PC%205.0;%20.NET%20CLR%203.5.30729;%20.NET%20CLR%203.0.30618)
</conversion_user_agent>
<click_user_agent/>
<disposition>
<approved>true</approved>
<disposition_name>Generic Voicemail</disposition_name>
<contact>John Doe</contact>
<disposition_date>2011-12-09T10:55:52.017</disposition_date>
</disposition>
<note/>
</conversion>
<conversion>
<conversion_id>110A3E03</conversion_id>
<visitor_id>1146503</visitor_id>
<request_session_id>152010</request_session_id>
<click_id xsi:nil="true"/>
<conversion_date>2011-12-09T07:09:19.557</conversion_date>
<last_updated>2013-01-23T20:53:56.547</last_updated>
<click_date xsi:nil="true"/>
<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>
<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>Click</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>0.0000</amount>
<formatted_amount>€0.00</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>
<country/>
<conversion_referrer_url/>
<click_referrer_url/>
<conversion_user_agent>
Mozilla/4.0%20(compatible;%20MSIE%206.0;%20Windows%20NT%205.1;%20SV1)
</conversion_user_agent>
<click_user_agent/>
<note/>
</conversion>
<conversion>
<conversion_id>699BA4F2</conversion_id>
<visitor_id>1146609</visitor_id>
<request_session_id>152120</request_session_id>
<click_id xsi:nil="true"/>
<conversion_date>2011-12-09T07:23:21.12</conversion_date>
<last_updated>2013-01-23T20:53:56.547</last_updated>
<click_date xsi:nil="true"/>
<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>
<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>Click</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>16.0000</amount>
<formatted_amount>€16.00</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>
<country/>
<conversion_referrer_url/>
<click_referrer_url/>
<conversion_user_agent>
Mozilla/4.0%20(compatible;%20MSIE%208.0;%20Windows%20NT%206.0;%20WOW64;%20Trident/4.0;%20SLCC1;%20.NET%20CLR%202.0.50727;%20Media%20Center%20PC%205.0;%20.NET%20CLR%203.5.30729;%20.NET%20CLR%203.0.30729)
</conversion_user_agent>
<click_user_agent/>
<disposition>
<approved>true</approved>
<disposition_name>Voicemail matches name</disposition_name>
<contact>John Doe</contact>
<disposition_date>2011-12-09T10:59:07.713</disposition_date>
</disposition>
<note/>
</conversion>
</conversions>
</conversion_report_response>

 

 

Example Error Messages: 

Error Message

Likely Cause

Invalid API Key

API Key does not exist or is expired

 

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.
Login
New support ticket Check ticket status