LinkConnector API Help Documentation

API Documentation
 

Campaign List - getMerchantCampaignList

  Specifications  
This api function returns all of your Campaigns.
Input Parameters
Field Name Required Type Format/Values (Default Bold) Description
Key Y String   Your API Key
Function Y String getMerchantCampaignList Function to call
Format N String CSV | JSON | XML Format of returned data
CampaignID N Integer   Campaign ID
CampaignStatus N String All | Active | Pending | Pending Launch | Inactive Status of the Campaign
Output Fields
Field Name Type Format Description
Campaign String   Campaign Name
CampaignID Integer   Campaign ID
Merchant String   Merchant Name
MerchantID Integer   Merchant ID
CampaignURL String   Landing Page URL associated with the Campaign
CampaignType String Standard | Naked Link Type of Campaign
CampaignScope String Public | Private All affiliates can apply to Public campaigns. Affiliates cannot apply to private campaigns - they must be invited.
CampaignEvents String   Events associated with the Campaign
CampaignLogoURL String   Campaign Logo Image URL
CampaignStartDate Date YYYY-MM-DD Start Date of the Campaign
CampaignEndDate Date YYYY-MM-DD End Date of the Campaign
CampaignStatus String Active | Pending | Pending Launch | Inactive Status of the Campaign


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 Merchant Relations department.