This api function returns detailed information for all available campaigns.
|
|
|
Field Name
|
Required
|
Type
|
Format/Values (Default Bold)
|
Description
|
|
Key
|
Y
|
String
|
|
Your API Key
|
|
Function
|
Y
|
String
|
getCampaignListDetails
|
Function to call
|
|
Format
|
N
|
ENUM
|
CSV | TXT | PSV | JSON | XML
|
Output data format (PSV is the pipe-delimited variation of CSV)
|
|
KeywordSearch
|
N
|
String
|
|
Limits the result set to rows matching the provided keyword
|
|
MerchantID
|
Y
|
Integer
|
|
Merchant ID
|
|
CampaignID
|
N
|
Integer
|
|
Filter based on Campaign ID
|
|
|
|
|
Field Name
|
Type
|
Format
|
Description
|
|
Merchant
|
String
|
|
Merchant Name
|
|
MerchantID
|
Integer
|
|
Merchant ID
|
|
CampaignName
|
String
|
|
Campaign Name
|
|
CampaignID
|
Integer
|
|
Campaign ID
|
|
Events
|
String
|
|
Events in Campaign
|
|
HTMLDescription
|
String
|
HTML (csv) | Encoded HTML (XML)
|
HTML Description of Campaign
|
|
Keywords
|
String
|
alphanumeric/500
|
Campaign Keywords
|
|
StartDate
|
String
|
|
Campaign Start Date
|
|
EndDate
|
String
|
|
Campaign End Date
|
|
AllowIncentiveSites
|
String
|
Yes | No
|
Campaign Allows Incentive Sites
|
|
AllowCouponSites
|
String
|
Yes | No
|
Campaign Allows Coupon Sites
|
|
CouponRestrictions
|
String
|
|
Coupon Restrictions
|
|
AllowSearchEngineMarketing
|
String
|
Yes | No
|
Campaign Allows Search Engine Marketing
|
|
SearchEngineRestrictions
|
String
|
|
Search Engine Marketing Restrictions
|
|
CampaignTerms
|
String
|
|
Campaign Terms
|
|
MerchantURL
|
String
|
|
The Merchant URL
|
|
AllowedCountries
|
String
|
|
Allowed Countries
|
|
Promotions
|
String
|
Yes | No
|
Returns 'Yes' when row has associated promotions
|
|
Approved
|
String
|
Yes | No
|
Campaign Approval Status
|
|
TrackingLink
|
String
|
|
Tracking Link
|
|
Category
|
String
|
|
Campaign Category
|
|
The input and output parameters represented in this documentation are the base functionality for each API function. If you require integration assistance,
additional output fields, specific input filters, or even new API functions to meet your specific requirements, please do not hesitate to contact our
Affiliate Relations department.
