EXPORT Campaigns API Version 8

Updated on 2018-03-21
Current Version: Version 8
Deprecated Version: 
V3V5, V6, V7
Requests Allowed: GET & SOAP


 

Summary:

Exports all campaigns potentially filtered by Campaign, Offer, Affiliate, account status or media type.

You can also obtain this from within your CAKE instance by going to the campaigns tab in the offer or Affiliate Cards where you are allowed to export. Additionally, you can go to Affiliates >> custom payouts grid >> Export. 


Resource/WSDL Page:

http://youradmindomainhere.com/api/8/export.asmx?op=Campaigns


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
campaign_id
Required
Type: INTEGER
Length (Max/Min): N/A

This is the identifier for a unique campaign. Must be non-zero if site_offer_id and source_affiliate_id are both set to 0


Example Values: 1234
site_offer_id
Required
Type: INTEGER
Length (Max/Min): N/A

This is the identifier for a unique Site/Offer.  This can be found on any Offer card. Must be non-zero if campaign_id and affiliate_id are both set to 0


Example Values: 1234
channel_id
Required
Type: INTEGER
Length (Max/Min): N/A
Unique identifier for Channel. Enter 0 for all Channels


Example: 0
source_affiliate_id
Required
Type: INTEGER
Length (Max/Min): N/A
This is the identifier for a unique Source/Affiliate.  This can be found on any Source/Affiliate card. Must be non-zero if offer_id and campaign_id are both set to 0

Example Values: 1234
account_status_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.


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.


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: INTEGER
Length (Max/Min): N/A

Accepts "campaign_id","date_created" or 0 to ignore this filter. The value could be any integer in order to ignore this filter.


Example Values: 3
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 to 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/8/export.asmx/Campaigns?api_key=dNJFmId9rI&campaign_id=0&site_offer_id=0&source_affiliate_id=1115519&channel_id=0&account_status_id=0&media_type_id=0&start_at_row=0&row_limit=0&sort_field=date_created&sort_descending=TRUE


Sample XML Response:

 

<campaign_export_response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://cakemarketing.com/api/8/">
<success>true</success>
<row_count>17</row_count>
<campaigns>
<campaign>
<campaign_id>1264144</campaign_id>
<channel>
<channel_id>1</channel_id>
<channel_name>Affiliate</channel_name>
</channel>
<campaign_type>
<campaign_type_id xmlns="API:id_name_store">2</campaign_type_id>
<campaign_type_name xmlns="API:id_name_store">Paid Upsell</campaign_type_name>
</campaign_type>
<source_affiliate>
<source_affiliate_id xmlns="API:id_name_store">1115519</source_affiliate_id>
<source_affiliate_name xmlns="API:id_name_store">Aldo AFF training</source_affiliate_name>
</source_affiliate>
<site_offer>
<site_offer_id xmlns="API:id_name_store">1000002710</site_offer_id>
<site_offer_name xmlns="API:id_name_store">Aldo Van</site_offer_name>
</site_offer>
<site_offer_contract>
<site_offer_contract_id>13929</site_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>
</site_offer_contract>
<original>true</original>
<exceptions>
<blocked_sub_ids/>
<blocked_creatives/>
</exceptions>
<account_status>
<account_status_id xmlns="API:id_name_store">1</account_status_id>
<account_status_name xmlns="API:id_name_store">Active</account_status_name>
</account_status>
<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>
<media_type>
<media_type_id xmlns="API:id_name_store">17</media_type_id>
<media_type_name xmlns="API:id_name_store">Linkout</media_type_name>
</media_type>
<display_link_type>
<link_display_type_id xmlns="API:id_name_store">1</link_display_type_id>
<link_display_type_name xmlns="API:id_name_store">Standard</link_display_type_name>
</display_link_type>
<event_overrides/>
<deal_flow>
<date_contacted xsi:nil="true"/>
<date_io_sent xsi:nil="true"/>
<date_io_signed xsi:nil="true"/>
<date_creative_sent xsi:nil="true"/>
<date_pixel_placed xsi:nil="true"/>
</deal_flow>
<payouts>
<payout>
<current_payout>true</current_payout>
<start_date>2018-02-01T09:54:14.767</start_date>
<payout_amount>
<is_percentage>false</is_percentage>
<amount>5.0000</amount>
<formatted_amount>$5.00</formatted_amount>
</payout_amount>
<notes>Auto Created on Upsell from Offer 1000002721</notes>
</payout>
</payouts>
<paid>true</paid>
<paid_redirects>true</paid_redirects>
<disable_prepop_appending>false</disable_prepop_appending>
<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>
<pixel_info>
<pixel_status>Pending</pixel_status>
<pixel_html/>
<postback_url/>
<postback_delay_ms xsi:nil="true"/>
</pixel_info>
<upsell_info>
<disable_upsells>false</disable_upsells>
<paid_upsells>true</paid_upsells>
<paid_upsells_same_session_only>false</paid_upsells_same_session_only>
<clear_session_on_conversion>false</clear_session_on_conversion>
</upsell_info>
<allow_device_ip>false</allow_device_ip>
<conversion_invalidation_threshold xsi:nil="true"/>
<blocked_ip_traffic_options>
<allow_blocked_ip_traffic>false</allow_blocked_ip_traffic>
</blocked_ip_traffic_options>
<voucher_codes/>
<test_link/>
<redirect_404>false</redirect_404>
<date_created>2018-02-01T09:54:14.767</date_created>
<expiration_date xsi:nil="true"/>
<notes>Auto Created on Upsell from Offer 1000002721</notes>
</campaign>