LinkConnector API Help Documentation

API Documentation
 

Link Detail - getMerchantLinkDetail

  Specifications  
This api function returns all of your Links.
Input Parameters
Field Name Required Type Format/Values (Default Bold) Description
Key Y String   Your API Key
Function Y String getMerchantLinkDetail Function to call
Format N String CSV | JSON | XML Format of returned data
CampaignID N Integer   Campaign ID
LinkStatus N String All | Active | Inactive | Expired Filter based on the Status of the Link
LinkType N String Image | Text | HTML | Flash Filter based on Link Type
Output Fields
Field Name Type Format Description
LinkID Integer   Link ID
LinkName String   Link Name
LinkType String   Link Type
LinkSize String [Width]x[Height] Dimensions of the Link in pixels
LinkImageURL String   For Link Types of Image, this is the Image URL.
LinkDestinationURL String   Destination URL for the Link
LinkStatus String   Status of the Link - Active, Inactive, Expired
LinkExpirationDate Date YYYY-MM-DD Date when the Link is scheduled to expire. Link Status will change to Expired on this date.
Merchant String   Merchant Name
MerchantID Integer   Merchant ID
CampaignIDs String   List of CampaignIDs that this Link is attached to.
Campaigns String   List of Campaigns


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.