EXPORT Advertisers API Version 6

Updated on 2015-01-15
Current Version: Version 6
Deprecated Version: V1, V2, V3, V4, V5
Requests Allowed: GET & SOAP

 

Summary:

Returns an array of advertisers filtered by advertiser_id, advertiser_name, account_manager_id, tag_id.


Resource/WSDL Page:

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

 

Parameters

api_key

Required

Type: STRING

Length (Max/Min): 50

Must be a valid API key (existing and NOT expired)

advertiser_id

Required

Type: INT

Length (Max/Min): NA 

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. 

Example Values: 90079

advertiser_name

Not Required

Type: STRING

Length (Max/Min): 50

Not required and can accept blank value.  Used to filter records matching the value or will return all records if blank.

Example Value: Tim's Advertiser

account_manager_id

Required

Type: INT

Length (Max/Min): NA

Filter for a specific contact ID. Contact IDs are available via export through the UI only. 

Example Values: 12

tag_id

Required

Type: INT

Length (Max/Min): NA

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

Example Values: 4

start_at_row

Required

Type: INT

Length (Max/Min): NA

Must pass at least 0 as value, which means start at the beginning of the data set.

Example Values: 0

row_limit

Required

Type: INT

Length (Max/Min): NA

Must pass at least 0 as value, which means no limit

Example Values: 0

sort_field

Required

Type: STRING

Length (Max/Min): NA

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

Example Values: advertiser_id

sort_descending

Required

Type: BOOL

Length (Max/Min): NA


Example Values:
True, False

 **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/Advertisers?api_key=dNJFmId9rI&advertiser_id=901367&advertiser_name=&account_manager_id=0&tag_id=0&start_at_row=1&row_limit=0&sort_field=advertiser_id&sort_descending=FALSE 



Sample XML Response:

 

<advertiser_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>
<advertisers>
<advertiser>
<advertiser_id>901367</advertiser_id>
<advertiser_name>CHRIS TEST</advertiser_name>
<account_managers>
<contact>
<contact_id xmlns="API:id_name_store">1120</contact_id>
<contact_name xmlns="API:id_name_store">John</contact_name>
</contact>
</account_managers>
<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>
<address>
<street_1/>
<street_2/>
<city/>
<state/>
<zip_code/>
<country/>
</address>
<website/>
<contacts/>
<tags/>
<credit_limits>
<credit>
<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>
<credit_limit>3751.0000</credit_limit>
<credit_used>40.0000</credit_used>
<prepaid_amount>0.0000</prepaid_amount>
<hard_cap>false</hard_cap>
<date_added>2015-07-01T17:54:39.29</date_added>
</credit>
</credit_limits>
<suppression_lists/>
<blacklists/>
<billing_cycle>
<billing_cycle_id xmlns="API:id_name_store">3</billing_cycle_id>
<billing_cycle_name xmlns="API:id_name_store">Monthly</billing_cycle_name>
</billing_cycle>
<events>
<event>
<event_id>1937</event_id>
<event_name>Conversion/Install/Lead</event_name>
<price_format>
<price_format_id xmlns="API:id_name_store">1</price_format_id>
<price_format_name xmlns="API:id_name_store">CPE</price_format_name>
</price_format>
<active>true</active>
<allow_duplicates>false</allow_duplicates>
<transaction_id_deduplication>
<type_id>0</type_id>
<type_name>Disabled</type_name>
</transaction_id_deduplication>
<payout>
<is_percentage>false</is_percentage>
<amount>0.0000</amount>
<formatted_amount>$0.00</formatted_amount>
<converted_amounts/>
</payout>
<received>
<is_percentage>false</is_percentage>
<amount>0.0000</amount>
<formatted_amount>$0.00</formatted_amount>
<converted_amounts/>
</received>
<portal>true</portal>
<active_for_all_offers>true</active_for_all_offers>
<fire_global_pixel>false</fire_global_pixel>
<postback_delay_ms xsi:nil="true"/>
<event_payout_and_received_trumps_other_sources>false</event_payout_and_received_trumps_other_sources>
</event>
</events>
<voucher_codes/>
<storefronts/>
<quickbooks_id xsi:nil="true"/>
<online_signup>false</online_signup>
<signup_ip_address/>
<api_key>MSwkDqk1EYdDeOQ6VHi4OCJqNxxj5k</api_key>
<date_created>2015-06-30T14:55:03.44</date_created>
<date_last_accepted_terms xsi:nil="true"/>
<notes/>
</advertiser>
</advertisers>
</advertiser_export_response>

  

Example Error Messages: 

Error Message

Likely Cause

Invalid API key

API key does not exist or is expired