REPORTS EventsConversions API Version 18
Updated on 03-13-2024
Current Version: Version 18
Deprecated Version: v4 - v17
Requests Allowed: GET/SOAP
Summary:
Exports all conversion info filtered by Campaign, Affiliate, Offer, Advertiser, Creative, Event, and many other parameters. This version accounts for Advertiser Sub ID values.
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:
https://<your_domain_here>/api/18/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
Sample XML Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<event_conversion_report_response xmlns="http://cakemarketing.com/api/18/">
<event_conversions>
<event_conversion>
<event_conversion_id>string</event_conversion_id>
<visitor_id>string</visitor_id>
<original_visitor_id>string</original_visitor_id>
<user_id>string</user_id>
<tracking_id>string</tracking_id>
<original_tracking_id>string</original_tracking_id>
<request_session_id>string</request_session_id>
<click_request_session_id>string</click_request_session_id>
<click_id>string</click_id>
<event_conversion_date>dateTime</event_conversion_date>
<last_updated>dateTime</last_updated>
<click_date>dateTime</click_date>
<source_date>dateTime</source_date>
<udid>string</udid>
<event_info>
<event_id xmlns="API:id_name_store">int</event_id>
<event_name xmlns="API:id_name_store">string</event_name>
</event_info>
<source_affiliate>
<source_affiliate_id xmlns="API:id_name_store">int</source_affiliate_id>
<source_affiliate_name xmlns="API:id_name_store">string</source_affiliate_name>
</source_affiliate>
<brand_advertiser>
<brand_advertiser_id xmlns="API:id_name_store">int</brand_advertiser_id>
<brand_advertiser_name xmlns="API:id_name_store">string</brand_advertiser_name>
</brand_advertiser>
<site_offer>
<site_offer_id xmlns="API:id_name_store">int</site_offer_id>
<site_offer_name xmlns="API:id_name_store">string</site_offer_name>
</site_offer>
<site_offer_contract>
<site_offer_contract_id xmlns="API:id_name_store">int</site_offer_contract_id>
<site_offer_contract_name xmlns="API:id_name_store">string</site_offer_contract_name>
</site_offer_contract>
<channel>
<channel_id xmlns="API:id_name_store">unsignedByte</channel_id>
<channel_name xmlns="API:id_name_store">string</channel_name>
</channel>
<campaign>
<campaign_id>int</campaign_id>
<campaign_name>string</campaign_name>
<campaign_third_party_name>string</campaign_third_party_name>
<campaign_type d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</campaign>
<creative>
<creative_id xmlns="API:id_name_store">int</creative_id>
<creative_name xmlns="API:id_name_store">string</creative_name>
</creative>
<voucher_code>string</voucher_code>
<sub_id_1>string</sub_id_1>
<sub_id_2>string</sub_id_2>
<sub_id_3>string</sub_id_3>
<sub_id_4>string</sub_id_4>
<sub_id_5>string</sub_id_5>
<event_conversion_ip_address>string</event_conversion_ip_address>
<click_ip_address>string</click_ip_address>
<event_conversion_referrer_url>string</event_conversion_referrer_url>
<click_referrer_url>string</click_referrer_url>
<event_conversion_user_agent>string</event_conversion_user_agent>
<click_user_agent>string</click_user_agent>
<source_type>string</source_type>
<price_format>
<price_format_id xmlns="API:id_name_store">unsignedByte</price_format_id>
<price_format_name xmlns="API:id_name_store">string</price_format_name>
</price_format>
<paid>
<currency_id>unsignedByte</currency_id>
<amount>decimal</amount>
<formatted_amount>string</formatted_amount>
</paid>
<paid_unbilled>
<currency_id>unsignedByte</currency_id>
<amount>decimal</amount>
<formatted_amount>string</formatted_amount>
</paid_unbilled>
<received>
<currency_id>unsignedByte</currency_id>
<amount>decimal</amount>
<formatted_amount>string</formatted_amount>
</received>
<received_unbilled>
<currency_id>unsignedByte</currency_id>
<amount>decimal</amount>
<formatted_amount>string</formatted_amount>
</received_unbilled>
<site_offer_credit_percentage>decimal</site_offer_credit_percentage>
<site_offer_payment_percentage>decimal</site_offer_payment_percentage>
<program_credit_percentage>decimal</program_credit_percentage>
<pixel_dropped>boolean</pixel_dropped>
<suppressed>boolean</suppressed>
<returned>boolean</returned>
<test>boolean</test>
<transaction_id>string</transaction_id>
<current_disposition>
<disposition_id>short</disposition_id>
<disposition_name>string</disposition_name>
<disposition_type d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<contact>string</contact>
<disposition_date>dateTime</disposition_date>
</current_disposition>
<order_total>
<currency_id>unsignedByte</currency_id>
<amount>decimal</amount>
<formatted_amount>string</formatted_amount>
</order_total>
<storefront>
<storefront_id xmlns="API:id_name_store">int</storefront_id>
<storefront_name xmlns="API:id_name_store">string</storefront_name>
</storefront>
<payout_rule>
<payout_rule_id xmlns="API:id_name_store">int</payout_rule_id>
<payout_rule_name xmlns="API:id_name_store">string</payout_rule_name>
</payout_rule>
<event_conversion_score>decimal</event_conversion_score>
<country>
<country_code xmlns="API:id_name_store">string</country_code>
<country_name xmlns="API:id_name_store">string</country_name>
</country>
<region>
<region_code xmlns="API:id_name_store">string</region_code>
<region_name xmlns="API:id_name_store">string</region_name>
</region>
<language>
<language_id xmlns="API:id_name_store">unsignedByte</language_id>
<language_name xmlns="API:id_name_store">string</language_name>
<language_abbr xmlns="API:id_name_store">string</language_abbr>
</language>
<isp>
<isp_id xmlns="API:id_name_store">int</isp_id>
<isp_name xmlns="API:id_name_store">string</isp_name>
</isp>
<device>
<device_id xmlns="API:id_name_store">short</device_id>
<device_name xmlns="API:id_name_store">string</device_name>
</device>
<operating_system>
<operating_system_id>unsignedByte</operating_system_id>
<operating_system_name>string</operating_system_name>
<operating_system_version d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<operating_system_version_minor d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</operating_system>
<browser>
<browser_id>unsignedByte</browser_id>
<browser_name>string</browser_name>
<browser_version d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<browser_version_minor d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</browser>
<search_term>string</search_term>
<keyword>string</keyword>
<note>string</note>
<adv_1>string</adv_1>
<adv_2>string</adv_2>
<adv_3>string</adv_3>
<adv_4>string</adv_4>
<adv_5>string</adv_5>
<adv_6>string</adv_6>
<adv_7>string</adv_7>
<adv_8>string</adv_8>
<adv_9>string</adv_9>
<adv_10>string</adv_10>
</event_conversion>