REPORTS EventsConversions API Version 17


Updated on 07-26-2017
Current Version: Version 15
Deprecated Version:  v4 v5 v6 v7 v8 v9 v10
 v11 v12 v13 v14 v15
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/17/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: ENUM
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: UNSIGNEDBYTE
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: SHORT
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: SHORT
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: SHORT
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: UNSIGNEDBYTE
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
source_type
Required
Type: ENUM
Length (Max/Min): N/A
Accepted Values: "all" or "click" or "impression" or "lead" or "manual_insertion" or "lite_click" or "voucher_code" or "none"

Example Values: lead
payment_percentage_filter
Required
Type: ENUM
Length (Max/Min): N/A
Accepted Values:
"both", "has_payment_percentage" or "no_payment_percentage"

Example Values: both
disposition_type
Required
Type: ENUM
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: ENUM
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: ENUM
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: ENUM
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

GET
http://staging.cakemarketing.com/api/17/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&source_type=all&payment_percentage_filter=both&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 



Sample XML Response:


<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>18</row_count>
<event_conversions>
<event_conversion>
<event_conversion_id>404422DA</event_conversion_id>
<visitor_id>5651398</visitor_id>
<original_visitor_id>5651398</original_visitor_id>
<tracking_id>1592689</tracking_id>
<original_tracking_id>1592689</original_tracking_id>
<request_session_id>4906500</request_session_id>
<event_conversion_date>2017-01-03T16:05:12.293</event_conversion_date>
<last_updated>2017-01-03T16:05:12.293</last_updated>
<click_date xsi:nil="true"/>
<source_date>2017-01-03T16:05:12.293</source_date>
<event_info>
<event_id xmlns="API:id_name_store">1701</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">1112090</source_affiliate_id>
<source_affiliate_name xmlns="API:id_name_store">Brittany Affiliate</source_affiliate_name>
</source_affiliate>
<brand_advertiser>
<brand_advertiser_id xmlns="API:id_name_store">901153</brand_advertiser_id>
<brand_advertiser_name xmlns="API:id_name_store">Brittany Adv.</brand_advertiser_name>
</brand_advertiser>
<site_offer>
<site_offer_id xmlns="API:id_name_store">55380795</site_offer_id>
<site_offer_name xmlns="API:id_name_store">Brittany Hosted</site_offer_name>
</site_offer>
<site_offer_contract>
<site_offer_contract_id xmlns="API:id_name_store">7698</site_offer_contract_id>
<site_offer_contract_name xmlns="API:id_name_store"/>
</site_offer_contract>
<campaign>
<campaign_id>762294</campaign_id>
<campaign_name>Test</campaign_name>
<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">1143300</creative_id>
<creative_name xmlns="API:id_name_store">1143300 - Test2</creative_name>
</creative>
<sub_id_1/>
<sub_id_2/>
<sub_id_3/>
<sub_id_4/>
<sub_id_5/>
<event_conversion_ip_address>64.60.178.90</event_conversion_ip_address>
<event_conversion_referrer_url/>
<event_conversion_user_agent/>
<source_type>Lead</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>5.0000</amount>
<formatted_amount>$5.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>0.0000000000</amount>
<formatted_amount>$0.00</formatted_amount>
</received>
<received_unbilled>
<currency_id>1</currency_id>
<amount>0.0000</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/>
<order_total>
<currency_id>1</currency_id>
<amount>0.0000</amount>
<formatted_amount>$0.00</formatted_amount>
</order_total>
<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">105</version_id>
<version_name xmlns="API:id_name_store">Yosemite (10.10)</version_name>
</operating_system_version>
<operating_system_version_minor>
<version_id xmlns="API:id_name_store">227</version_id>
<version_name xmlns="API:id_name_store"/>
</operating_system_version_minor>
</operating_system>
<browser>
<browser_id>2</browser_id>
<browser_name>Chrome</browser_name>
<browser_version>
<version_id xmlns="API:id_name_store">443</version_id>
<version_name xmlns="API:id_name_store">55</version_name>
</browser_version>
<browser_version_minor>
<version_id xmlns="API:id_name_store">612</version_id>
<version_name xmlns="API:id_name_store">55.0</version_name>
</browser_version_minor>
</browser>
<note/>
</event_conversion>