LinkConnector API Help Documentation

API Documentation
 

Affiliate Detail - getMerchantCampaignAffiliateDetail

  Specifications  
This api function returns all of your Affiliates for all of your Campaigns.
Input Parameters
Field Name Required Type Format/Values (Default Bold) Description
Key Y String   Your API Key
Function Y String getMerchantCampaignAffiliateDetail Function to call
Format N String CSV | JSON | XML Format of returned data
CampaignID N Integer   Campaign ID
AffiliateStatus N String All | Approved | Offered | Pending | Declined | Rejected | Removed | Dropped Status of the relationship for the given CampaignID, AffiliateID, and AffiliateURL
StatusPeriod N String Yesterday | Last1Week | ThisMonth | LastMonth | Last30Days | Today Filter using StatusDate based on date range (Overrides StartDate and EndDate)
StatusStartDate N Date YYYY-MM-DD Start Date of Status Date filter
StatusEndDate N Date YYYY-MM-DD End Date of Status Date filter
Output Fields
Field Name Type Format Description
Affiliate String   Affiliate Name
AffiliateID Integer   Affiliate ID
Campaign String   Campaign Name
CampaignID Integer   Campaign ID
Merchant String   Merchant Name
MerchantID Integer   Merchant ID
AffiliateURL String   Affiliate site URL
IncentiveSite String Y | N Returns 'Y' if site is an incentive site
Login String Y | N Returns 'Y' if site is a login required site
AffiliateStatus String Approved | Offered | Pending | Declined | Rejected | Removed | Dropped Status of the relationship for the given CampaignID, AffiliateID, and AffiliateURL
AppliedDate Date YYYY-MM-DD Date on which either the Affiliate applied to the campaign or the Merchant made the offer to the Affiliate.
ApprovedDate Date YYYY-MM-DD Date on which Affiliate Site was approved
StatusDate Date YYYY-MM-DD Date of the last status change for this relationship


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.