REPORTS Conversions API Version 15 (DEPRECATED)

Chie Silver

Modified on: Wed, 16 Aug, 2017 at 11:01 AM

REPORTS Conversions API V15

Updated on 2015-10-23
Current Version: Version 15
Deprecated Version: v4 v5 v6 v7 v8 v9 v10 v11 v12 v13 v14 v17
Requests Allowed: GET/SOAP

Summary:

Exports all conversion info filtered by campaign, affiliate offer, advertiser, creative, event, and many other parameters.

You can also obtain this from within your CAKE instance by going to the Conversion report, where you are allowed to export.

Resource/WSDL Page:

http://<your_domain_here>/api/15/reports.asmx?op=EventConversions

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 (existing and NOT expired) Example Values: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh
start_date Required Type: DATE Length (Max/Min): N/A	This start date will filter all conversions from a specific date. Midnight is represented as 00:00:00. Allowed formats: "YYYY-mm-dd","dd-mm-YYYY","mm/dd/YYYY","mm/dd/YYYY HH:mm:ss" Example Values: 2014-02-15, 12/2/2014 00:00:00
end_date Required Type: DATE Length (Max/Min): N/A	This end date will filter all conversions from a specific date. Midnight is represented as 00:00:00. When time stamp is excluded 00:00:00 is assumed and data on end date will not be included. Allowed formats: "YYYY-mm-dd","dd-mm-YYYY","mm/dd/YYYY","mm/dd/YYYY HH:mm:ss" Example Values: 2014-02-16, 12/2/2014 01:00:00
event_type Required Type: STRING Length (Max/Min): N/A	The type of conversions to include in the response. ["all" or "micro_events" or "macro_event_conversions"]
event_id Required Type: INT	Filter to reduce report to only a specific event. Obtained via EXPORT Offers API Passing anything <= 0 the result will include all events. Example Values: 253
source_affiliate_id Required Type: INT Length (Max/Min): N/A	This is the identifier for a unique Affiliate. Obtained via EXPORT Affiliates API Passing anything <= 0 the result will include all affiliates. Example Values: 1234
brand_advertiser_id Required Type: INT Length (Max/Min): N/A	This is the identifier for a unique Advertiser. Obtained via EXPORT Advertisers API Passing anything <= 0 the result will include all advertisers. Example Values: 1234
channel_id Required Type: INT Length (Max/Min): N/A	Only used in CAKE for Advertisers product. Pass 0 to skip
site_offer_id Required Type: INT Length (Max/Min): N/A	This is the identifier for a unique Offer. Obtained via EXPORT Offers API If passing anything <= 0 the result will include all offers. Example Values: 1234
site_offer_contract_id Required Type: INT Length (Max/Min): N/A	This is the identifier for a unique Offer Contract ID. Obtained via EXPORT Offers API If passing anything <= 0 the result will include all offers. Example Values: 1234
source_affiliate_tag_id Required Type: INT Length (Max/Min): N/A	Affiliate Tag ID, used to filter the response by traffic from tagged Affiliates. Obtained via GET AffiliateTags API Passing anything <= 0 the result will include all affiliates.
brand_advertiser_tag_id Required Type: INT Length (Max/Min): N/A	Advertiser Tag ID, used to filter the response by traffic from tagged Advertiser. Obtained via EXPORT Advertisers API Passing anything <= 0 the result will include all affiliates.
site_offer_tag_id Required Type: INT Length (Max/Min): N/A	Offer Tag ID, used to filter the response by traffic from tagged Offers. Obtained via EXPORT Offers API
campaign_id Required Type: INT Length (Max/Min): N/A	This is the identifier for a unique Campaign. Obtained via EXPORT Campaigns API Passing anything <= 0 the result will include all campaigns. Example Values: 1234
creative_id Required Type: INT Length (Max/Min): N/A	This is the identifier for a unique Creative. Obtained via EXPORT Creatives API Passing anything <= 0 the result will include all creatives. Example Values: 1234
price_format_id Required Type: INT Length (Max/Min): N/A	Price Format ID, used to filter the response by specific price format. Obtained via GET PriceFormats API https://support.getcake.com/solution/articles/5000546239-get-priceformats-api-version-1
disposition_type Required Type: STRING Length (Max/Min): N/A	Disposition Type, used to filter the response by disposition type passed. ["all", "pending", "rejected", "approved", "returned"]
disposition_id Required Type: SHORT Length (Max/Min): N/A	This is the disposition identifier. Obtained via TRACK ConversionDispositions API Passing anything <= 0 the result will include all dispositions.
source_affiliate_billing_status Required Type: STRING Length (Max/Min): N/A	Used to filter the response of the report, by actions billing status. ["all", "billed", "unbilled", "partial"]
brand_advertiser_billing_status Required Type: STRING Length (Max/Min): N/A	Used to filter the response of the report, by actions billing status. ["all", "billed", "unbilled", "partial"]
test_filter Required Type: STRING Length (Max/Min): N/A	Used to drive whether test conversions are returned. ["both", "tests" or "non_tests"]
start_at_row Required Type: INT Length (Max/Min): N/A	Must pass at least 0 as value, which means start at the beginning of the data set. Example Values: 1
row_limit Required Type: INT Length (Max/Min): N/A	Must pass at some value, 100000 rows is the max allowed which means no limit. Example Values: 3
sort_field Required Type: STRING Length (Max/Min): N/A	Accepts "event_conversion_id" or "visitor_id" or "request_session_id" or "click_id" or "event_conversion_date" or "transaction_id" or "last_updated" Example Values: event_conversion_id
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

http://staging.cakemarketing.com/api/15/reports.asmx/EventConversions?api_key=qxW6I5bGSfbVpCpN12FVPIiQWQVj4En&start_date=01-01-2017&end_date=01-05-2017&source_affiliate_id=0&brand_advertiser_id=0&site_offer_id=0&campaign_id=0&creative_id=0&event_type=all&event_id=0&channel_id=0&site_offer_contract_id=0&source_affiliate_tag_id=0&brand_advertiser_tag_id=0&site_offer_tag_id=0&price_format_id=0&disposition_type=all&disposition_id=0&source_affiliate_billing_status=all&brand_advertiser_billing_status=all&test_filter=non_tests&start_at_row=1&row_limit=20&sort_field=visitor_id&sort_descending=false

<conversion_report_response>
<success>true</success>
<row_count>1</row_count>
<conversions>
<conversion>
<conversion_id>859533</conversion_id>
<visitor_id>4845159</visitor_id>
<request_session_id>4097890</request_session_id>
<click_request_session_id>4097890</click_request_session_id>
<click_id>4076273</click_id>
<conversion_date>2015-09-18T13:42:19.42</conversion_date>
<last_updated>2015-09-18T13:42:19.42</last_updated>
<click_date>2015-09-18T13:42:09.403</click_date>
<event_info>
<event_id>2120</event_id>
<event_name>Event</event_name>
</event_info>
<affiliate>
<affiliate_id>1111455</affiliate_id>
<affiliate_name>!!! Test Affiliate 4</affiliate_name>
</affiliate>
<advertiser>
<advertiser_id>901548</advertiser_id>
<advertiser_name>ADV B lBrad</advertiser_name>
</advertiser>
<offer>
<offer_id>55380389</offer_id>
<offer_name>A off</offer_name>
</offer>
<offer_contract>
<offer_contract_id>7216</offer_contract_id>
<offer_contract_name/>
</offer_contract>
<campaign>
<campaign_id>761186</campaign_id>
<campaign_type>
<campaign_type_id>1</campaign_type_id>
<campaign_type_name>Standard</campaign_type_name>
</campaign_type>
</campaign>
<creative>
<creative_id>1138947</creative_id>
<creative_name>1138947</creative_name>
</creative>
<sub_id_1/>
<sub_id_2/>
<sub_id_3/>
<sub_id_4/>
<sub_id_5/>
<conversion_ip_address>12.199.136.146</conversion_ip_address>
<click_ip_address>12.199.136.146</click_ip_address>
<conversion_referrer_url/>
<click_referrer_url>http://staging.cakemarketing.com/test.aspx?c=761186</click_referrer_url>
<conversion_user_agent>Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/45.0.2454.85 Safari/537.36</conversion_user_agent>
<click_user_agent>Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/45.0.2454.85 Safari/537.36</click_user_agent>
<source_type>Click</source_type>
<price_format>
<price_format_id>1</price_format_id>
<price_format_name>CPA</price_format_name>
</price_format>
<paid>
<currency_id>1</currency_id>
<amount>165.0000</amount>
<formatted_amount>$165.00</formatted_amount>
</paid>
<paid_unbilled>
<currency_id>1</currency_id>
<amount>0.0000</amount>
<formatted_amount>$0.00</formatted_amount>
</paid_unbilled>
<received>
<currency_id>1</currency_id>
<amount>546.0000000000</amount>
<formatted_amount>$546.00</formatted_amount>
</received>
<received_unbilled>
<currency_id>1</currency_id>
<amount>0.0000</amount>
<formatted_amount>$0.00</formatted_amount>
</received_unbilled>
<step_reached>1</step_reached>
<pixel_dropped>false</pixel_dropped>
<suppressed>false</suppressed>
<returned>false</returned>
<test>false</test>
<transaction_id>InactiveEvent</transaction_id>
<current_disposition>
<disposition_id>1</disposition_id>
<disposition_name>Pending</disposition_name>
<disposition_type>
<disposition_type_id>1</disposition_type_id>
<disposition_type_name>Pending</disposition_type_name>
</disposition_type>
<contact>System Process</contact>
<disposition_date>2015-09-18T13:42:19.42</disposition_date>
</current_disposition>
<order_total>
<currency_id>1</currency_id>
<amount>0.0000</amount>
<formatted_amount>$0.00</formatted_amount>
</order_total>
<conversion_score>-0.01</conversion_score>
<country>
<country_code>US</country_code>
<country_name>United States</country_name>
</country>
<region>
<region_code>CA</region_code>
<region_name>California</region_name>
</region>
<language>
<language_id>1</language_id>
<language_name>English</language_name>
</language>
<isp>
<isp_id>33036</isp_id>
<isp_name>Att Services Inc.</isp_name>
</isp>
<operating_system>
<operating_system_id>18</operating_system_id>
<operating_system_name>Windows</operating_system_name>
<operating_system_version>
<version_id>1</version_id>
<version_name>Other</version_name>
</operating_system_version>
<operating_system_version_minor>
<version_id>1</version_id>
<version_name/>
</operating_system_version_minor>
</operating_system>
<browser>
<browser_id>2</browser_id>
<browser_name>Chrome</browser_name>
<browser_version>
<version_id>24</version_id>
<version_name>Other</version_name>
</browser_version>
<browser_version_minor>
<version_id>24</version_id>
<version_name/>
</browser_version_minor>
</browser>
<note/>
</conversion>
</conversions>
</conversion_report_response>

Example Error Messages:

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

REPORTS Conversions API V15

Resource/WSDL Page:

Parameters

**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

Related Articles