REPORTS EventConversionChanges API

Updated on 2018-03-27
Current Version: Version 17
Deprecated Version: V5, V6, V10
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/17/reports.asmx?op=EventConversionChanges



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_event_conversions
Required
Type: BOOL
Length (Max/Min): N/A
Drives whether only changed conversions are returned or new ones as well.
Example Values: TRUE or FALSE
source_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
brand_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
site_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: TRUE or FALSE
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: SHORT
Length (Max/Min): N/A
Accepts "event_conversion_id", "visitor_id", "request_session_id", "click_id", "event_conversion_date", "transaction_id" or "last_updated"
Example Values: event_conversion_date
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 or FALSE



Example Request

GET
http://cs1.cakemarketing.com/api/17/reports.asmx/EventConversionChanges?
api_key=7h5wniMrGuyizGE52P9Vg&changes_since=01/01/2012+12:00:00
&include_new_event_conversions=TRUE&source_affiliate_id=2&brand_advertiser_id=0
&site_offer_id=0&campaign_id=0&creative_id=0&include_tests=TRUE
&start_at_row=1&row_limit=5&sort_field=event_conversion_date
&sort_descending=FALSE

 

<event_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/17/">
<success>true</success>
<row_count>84</row_count>
<event_conversions>
<event_conversion>
<event_conversion_id>3DA1BD82</event_conversion_id>
<visitor_id>100000</visitor_id>
<original_visitor_id>100000</original_visitor_id>
<user_id/>
<tracking_id>10</tracking_id>
<original_tracking_id>10</original_tracking_id>
<request_session_id>100108</request_session_id>
<click_request_session_id>100108</click_request_session_id>
<click_id>100119</click_id>
<event_conversion_date>2018-01-29T16:21:58.763</event_conversion_date>
<last_updated>2018-01-29T16:21:58.763</last_updated>
<click_date>2018-01-29T16:21:53.923</click_date>
<source_date>2018-01-29T16:21:53.923</source_date>
<udid/>
<event_info>
<event_id xmlns="API:id_name_store">2</event_id>
<event_name xmlns="API:id_name_store">Conversion/Install/Lead</event_name>
</event_info>
<source_affiliate>
<source_affiliate_id xmlns="API:id_name_store">2</source_affiliate_id>
<source_affiliate_name xmlns="API:id_name_store">Aldo's AFF 1</source_affiliate_name>
</source_affiliate>
<brand_advertiser>
<brand_advertiser_id xmlns="API:id_name_store">2</brand_advertiser_id>
<brand_advertiser_name xmlns="API:id_name_store">Aldo's Ad</brand_advertiser_name>
</brand_advertiser>
<site_offer>
<site_offer_id xmlns="API:id_name_store">5</site_offer_id>
<site_offer_name xmlns="API:id_name_store">Aldo's Hosted</site_offer_name>
</site_offer>
<site_offer_contract>
<site_offer_contract_id xmlns="API:id_name_store">7</site_offer_contract_id>
<site_offer_contract_name xmlns="API:id_name_store"/>
</site_offer_contract>
<channel>
<channel_id xmlns="API:id_name_store">1</channel_id>
<channel_name xmlns="API:id_name_store">Affiliate</channel_name>
</channel>
<campaign>
<campaign_id>14</campaign_id>
<campaign_type>
<campaign_type_id>1</campaign_type_id>
<campaign_type_name>Standard</campaign_type_name>
</campaign_type>
</campaign>
<creative>
<creative_id xmlns="API:id_name_store">7</creative_id>
<creative_name xmlns="API:id_name_store">7</creative_name>
</creative>
<voucher_code/>
<sub_id_1/>
<sub_id_2>takeme</sub_id_2>
<sub_id_3/>
<sub_id_4/>
<sub_id_5/>
<event_conversion_ip_address>64.60.178.90</event_conversion_ip_address>
<click_ip_address>64.60.178.90</click_ip_address>
<event_conversion_referrer_url/>
<click_referrer_url/>
<event_conversion_user_agent>
Mozilla/5.0%20(Macintosh;%20Intel%20Mac%20OS%20X%2010.12;%20rv:58.0)%20Gecko/20100101%20Firefox/58.0
</event_conversion_user_agent>
<click_user_agent>
Mozilla/5.0%20(Macintosh;%20Intel%20Mac%20OS%20X%2010.12;%20rv:58.0)%20Gecko/20100101%20Firefox/58.0
</click_user_agent>
<source_type>Click</source_type>
<price_format>
<price_format_id xmlns="API:id_name_store">1</price_format_id>
<price_format_name xmlns="API:id_name_store">CPA</price_format_name>
</price_format>
<paid>
<currency_id>1</currency_id>
<amount>51.0000</amount>
<formatted_amount>$51.00</formatted_amount>
</paid>
<paid_unbilled>
<currency_id>1</currency_id>
<amount>0.00000000000000</amount>
<formatted_amount>$0.00</formatted_amount>
</paid_unbilled>
<received>
<currency_id>1</currency_id>
<amount>0.0000000000</amount>
<formatted_amount>$0.00</formatted_amount>
</received>
<received_unbilled>
<currency_id>1</currency_id>
<amount>0.00000000000000</amount>
<formatted_amount>$0.00</formatted_amount>
</received_unbilled>
<site_offer_credit_percentage>1.000000</site_offer_credit_percentage>
<site_offer_payment_percentage>1.000000</site_offer_payment_percentage>
<program_credit_percentage xsi:nil="true"/>
<pixel_dropped>false</pixel_dropped>
<suppressed>false</suppressed>
<returned>false</returned>
<test>false</test>
<transaction_id/>
<event_conversion_score xsi:nil="true"/>
<country>
<country_code xmlns="API:id_name_store">US</country_code>
<country_name xmlns="API:id_name_store">United States</country_name>
</country>
<region>
<region_code xmlns="API:id_name_store">CA</region_code>
<region_name xmlns="API:id_name_store">California</region_name>
</region>
<language>
<language_id xmlns="API:id_name_store">1</language_id>
<language_name xmlns="API:id_name_store">English</language_name>
</language>
<isp>
<isp_id xmlns="API:id_name_store">29429</isp_id>
<isp_name xmlns="API:id_name_store">Telepacific Communications</isp_name>
</isp>
<operating_system>
<operating_system_id>17</operating_system_id>
<operating_system_name>Mac Os</operating_system_name>
<operating_system_version>
<version_id xmlns="API:id_name_store">15</version_id>
<version_name xmlns="API:id_name_store">Puma (10.1)</version_name>
</operating_system_version>
<operating_system_version_minor>
<version_id xmlns="API:id_name_store">15</version_id>
<version_name xmlns="API:id_name_store"/>
</operating_system_version_minor>
</operating_system>
<browser>
<browser_id>3</browser_id>
<browser_name>Firefox</browser_name>
<browser_version>
<version_id xmlns="API:id_name_store">509</version_id>
<version_name xmlns="API:id_name_store">58</version_name>
</browser_version>
<browser_version_minor>
<version_id xmlns="API:id_name_store">754</version_id>
<version_name xmlns="API:id_name_store">58.0</version_name>
</browser_version_minor>
</browser>
<search_term/>
<keyword/>
<note/>
</event_conversion>