EXPORT Campaigns API Version 5

Updated on 2014-03-24
Current Version: Version 6
Depricated Version: 
V3V5
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://yourdomainhere.com/api/6/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. You can obtain the campaign ID from your CAKE instance on the campaign card. To get there, go to the advertiser tab >> offers >> choose an offer to open the offer card >> campaign tab >> choose a campaign >> ID. 

Example Values: 1234

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

This is the identifier for a unique Offer.  This can be found on any Offer card.

Example Values: 1234

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

This is the identifier for a unique Affiliate.  This can be found on any Affiliate card.

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 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/Campaigns?api_key=dNJFmId9rI&campaign_id=30777&offer_id=0&affiliate_id=0&account_status_id=1&media_type_id=0&start_at_row=0&row_limit=0&sort_field=date_created&sort_descending=TRUE

 

Sample XML Response:

<campaign_export_response>
  <success>true</success>
  <row_count>15</row_count>
  <campaign>
      <campaign_id>16688</campaign_id>
      <campaign_type>
        <campaign_type_id xmlns="API:id_name_store">1</campaign_type_id>
        <campaign_type_name xmlns="API:id_name_store">Standard</campaign_type_name>
      </campaign_type>
      <affiliate>
        <affiliate_id xmlns="API:id_name_store">5750</affiliate_id>
        <affiliate_name xmlns="API:id_name_store">Chie Affiliate Network</affiliate_name>
      </affiliate>
      <offer>
        <offer_id xmlns="API:id_name_store">1001507</offer_id>
        <offer_name xmlns="API:id_name_store">chie test HOSTED</offer_name>
      </offer>
      <offer_contract>
        <offer_contract_id>2684</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>
      </offer_contract>
      <original>true</original>
      <exceptions>
        <blocked_sub_affiliates/>
        <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>
      <payout>
        <is_percentage>false</is_percentage>
        <amount>27.0000</amount>
        <formatted_amount>$27.00</formatted_amount>
      </payout>
      <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">15</media_type_id>
        <media_type_name xmlns="API:id_name_store">Adware</media_type_name>
      </media_type>
      <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>
      <paid>true</paid>
      <paid_redirects>true</paid_redirects>
      <disable_prepop_appending>false</disable_prepop_appending>
      <suppression_amount>100</suppression_amount>
      <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>false</paid_upsells>
        <paid_upsells_same_session_only>false</paid_upsells_same_session_only>
        <clear_session_on_conversion>false</clear_session_on_conversion>
      </upsell_info>
      <submission_options>
        <post_key>fBLydUCAYhj4IjL3vkgXg</post_key>   - NEW!    
        <review>false</review>
        <minimum_margin_percentage>0.00</minimum_margin_percentage>
        <minimum_margin_amount>0.0000</minimum_margin_amount>
        <paid_filters/>
      </submission_options>
      <test_link/>
      <redirect_404>false</redirect_404>
      <date_created>2013-06-11T16:05:57.67</date_created>
      <expiration_date xsi:nil="true"/>
      <notes/>
    </campaign>
</campaign_export_response>

 

Example Error Messages: 

Error Message

Likely Cause

Invalid API Key

API Key does not exist or is expired

Invalid Affiliate ID

Affiliate ID does not exist

Invalid Offer ID Offer ID does not exist