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 |
Sample XML Response:
Example Error Messages:
Error Message | Likely Cause |
Invalid API key | API key does not exist or is expired |