EXPORT Offers API Version 6

Updated on 2015-08-14
Current Version: 6
Deprecated Version: 
V1, V2, V3, V4, V5

Requests Allowed: GET & SOAP

 

Summary:

Returns an array of offers potentially filtered by offer id, offer name, advertiser id, vertical id, offer type id, media type id, offer status id or tag id.

You can also obtain this from within your CAKE instance by going to the advertiser tab >> offers >> export. 

 

Resource/WSDL Page:

http://<your_domain_here>/api/6/export.asmx?op=Offers

 

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.

Example Value: 

Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh

offer_name
Required
Type: String
Length (Max/Min): 50

Leave blank = ALL Offer names

Example Values: ACME Offer

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

This is the identifier for a unique Offer.  Use EXPORT Offer API

0 = ALL Offer IDs

Example Values: 1234

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

If passing anything <= 0 the result will include all advertisers. If the advertiser ID does not exist, it will return an empty array instead of an error. You can obtain the advertiser ID from within your CAKE instance under the Advertiser tab >> ID

Example Values: 1234

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

Must pass at least >= 0 as value. Used to filter records matching the value or will return all records if <=0. Use EXPORT Verticals API

Example Values: 3

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

Must pass at least >= 0 as value. Used to filter records matching the value or will return all records if <=0. Use GET OfferTypes API

Example Values: 3

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

Must pass at least >= 0 as value. Used to filter records matching the value or will return all records if <=0. Use GET MediaTypes API

Example Values: 3

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

Obtained via previous EXPORT Offers call

Example Values: 3

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: STRING
Length (Max/Min): 50

Accepts "offer_id","offer_name", "date_created", "expiration_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

offer_status_id                                                                                                                                                                   Required

Type: Integer
Length (Max/Min): 50

Sstatus of the offer. Use GET OfferStatuses API


Example Values: 

1 

 **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/6/export.asmx/Offers?api_key=dNJFmId9rI&offer_id=55378734&offer_name=&advertiser_id=0&vertical_id=0&offer_type_id=0&media_type_id=0&tag_id=0&start_at_row=0&row_limit=3&sort_field=offer_id&sort_descending=FALSE&offer_status_id=0



Sample XML Response:

 

<offer_export_response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://cakemarketing.com/api/6/">
<success>true</success>
<row_count>1</row_count>
<offers>
<offer>
<offer_id>55380154</offer_id>
<offer_name>Tim's Offer Step 1</offer_name>
<advertiser>
<advertiser_id xmlns="API:id_name_store">900988</advertiser_id>
<advertiser_name xmlns="API:id_name_store">Tim's Advertiser 2</advertiser_name>
</advertiser>
<vertical>
<vertical_id xmlns="API:id_name_store">885</vertical_id>
<vertical_name xmlns="API:id_name_store">Tim's Vertical</vertical_name>
</vertical>
<offer_type>
<offer_type_id xmlns="API:id_name_store">3</offer_type_id>
<offer_type_name xmlns="API:id_name_store">3rd Party</offer_type_name>
</offer_type>
<offer_status>
<offer_status_id xmlns="API:id_name_store">1</offer_status_id>
<offer_status_name xmlns="API:id_name_store">Public</offer_status_name>
</offer_status>
<hidden>false</hidden>
<offer_image_link/>
<default_offer_contract_id>6886</default_offer_contract_id>
<offer_contracts>
<offer_contract_info>
<offer_contract_id>6886</offer_contract_id>
<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>
<current_payout>
<is_percentage>false</is_percentage>
<amount>25.0000</amount>
<formatted_amount>$25.00</formatted_amount>
</current_payout>
<current_received>
<is_percentage>false</is_percentage>
<amount>50.0000</amount>
<formatted_amount>$50.00</formatted_amount>
</current_received>
<offer_link>http://www.google.com</offer_link>
<thankyou_link/>
<hidden>false</hidden>
<targeting_method>
<targeting_method_id xmlns="API:id_name_store">4</targeting_method_id>
<targeting_method_name xmlns="API:id_name_store">None</targeting_method_name>
</targeting_method>
<event_overrides/>
<payouts>
<payout>
<current_payout>true</current_payout>
<start_date>2015-07-24T16:35:03.433</start_date>
<payout_amount>
<is_percentage>false</is_percentage>
<amount>25.0000</amount>
<formatted_amount>$25.00</formatted_amount>
</payout_amount>
<notes/>
</payout>
</payouts>
<prices_received>
<price_received>
<current_price_received>true</current_price_received>
<start_date>2015-07-24T16:35:03.433</start_date>
<price_received_amount>
<is_percentage>false</is_percentage>
<amount>50.0000</amount>
<formatted_amount>$50.00</formatted_amount>
</price_received_amount>
<notes/>
</price_received>
</prices_received>
</offer_contract_info>
</offer_contracts>
<tiers/>
<tags/>
<allowed_media_types/>
<currency>
<currency_id xmlns="API:id_name_store">1</currency_id>
<currency_symbol xmlns="API:id_name_store">$</currency_symbol>
<currency_name xmlns="API:id_name_store">US Dollar</currency_name>
<currency_abbr xmlns="API:id_name_store">USD</currency_abbr>
</currency>
<ssl>false</ssl>
<suppression_amount xsi:nil="true"/>
<click_cap>
<limit xsi:nil="true"/>
<cap_interval>
<cap_interval_id xmlns="API:id_name_store">0</cap_interval_id>
<cap_interval_name xmlns="API:id_name_store">None</cap_interval_name>
</cap_interval>
<start_date xsi:nil="true"/>
<review_no_redirect>false</review_no_redirect>
</click_cap>
<conversion_cap>
<limit xsi:nil="true"/>
<cap_interval>
<cap_interval_id xmlns="API:id_name_store">0</cap_interval_id>
<cap_interval_name xmlns="API:id_name_store">None</cap_interval_name>
</cap_interval>
<start_date xsi:nil="true"/>
<review_no_redirect>false</review_no_redirect>
</conversion_cap>
<click_cookie_days>30</click_cookie_days>
<impression_cookie_days>30</impression_cookie_days>
<enable_view_thru_conversions>false</enable_view_thru_conversions>
<click_trumps_impression>false</click_trumps_impression>
<disable_click_deduplication>false</disable_click_deduplication>
<disable_impression_deduplication>false</disable_impression_deduplication>
<voucher_code_attribution>
<voucher_code_attribution_id xmlns="API:id_name_store">0</voucher_code_attribution_id>
<voucher_code_attribution_name xmlns="API:id_name_store">Default to Global</voucher_code_attribution_name>
</voucher_code_attribution>
<last_touch>false</last_touch>
<enable_transaction_id_deduplication>false</enable_transaction_id_deduplication>
<conversions_from_whitelist_only>false</conversions_from_whitelist_only>
<pixel_info>
<pixel_html/>
<postback_url/>
<postback_delay_ms xsi:nil="true"/>
</pixel_info>
<fire_global_pixel>true</fire_global_pixel>
<fire_pixel_on_non_paid_conversions>false</fire_pixel_on_non_paid_conversions>
<disable_prepop_appending>false</disable_prepop_appending>
<redirect_404>false</redirect_404>
<session_regeneration_seconds xsi:nil="true"/>
<unsubscribe_link/>
<preview_link/>
<offer_description/>
<restrictions/>
<advertiser_extended_terms/>
<testing_instructions/>
<from_lines/>
<subject_lines/>
<upsells>
<upsell>
<offer_contract>
<offer_contract_id xmlns="API:id_name_store">6887</offer_contract_id>
<offer_contract_name xmlns="API:id_name_store">Tim's Offer Step 1 - CPA - $90.98</offer_contract_name>
</offer_contract>
<creative>
<creative_id xmlns="API:id_name_store">1138577</creative_id>
<creative_name xmlns="API:id_name_store">1138577 - Upsell - Image</creative_name>
</creative>
<order>1</order>
<top_html/>
<bottom_html>
<p>Not interested in this offer? Click <a href="#nextoffer#">here</a> to continue.</p>
</bottom_html>
<prepop_link>false</prepop_link>
</upsell>
</upsells>
<thankyou_html/>
<date_created>2015-07-24T16:35:03.387</date_created>
<expiration_date xsi:nil="true"/>
<notes/>
</offer>
</offers>
</offer_export_response>


 

 Example Error Messages: 

Error Message

Likely Cause

Invalid API Key

API Key does not exist or is expired