LinkConnector API Help Documentation

API Documentation
 

ATID Report - getReportATID

  Specifications  
This api function returns traffic statistics for your Affiliate Tracking Identifiers.
Input Parameters
Field Name Required Type Format/Values (Default Bold) Description
Key Y String   Your API Key
Function Y String getReportATID Function to call
Format N ENUM CSV | TXT | PSV | JSON | XML Output data format (PSV is the pipe-delimited variation of CSV)
MerchantID Y Integer   Merchant ID
Period N String All | Yesterday | Last1Week | ThisMonth | LastMonth | Last30Days | Today Filter based on date range (Overrides StartDate and EndDate)
StartDate N Date YYYY-MM-DD Start date filter (Default: Today)
EndDate N Date YYYY-MM-DD End date filter (Default: Today)
Output Fields
Field Name Type Format Description
ATID String   ATID Value
Merchants String   CSV list of Merchants included in row summary
Campaigns String   List of Campaigns
Impressions Integer   Number of Impressions
Clicks Integer   Number of Clicks
Leads Integer   Number of Leads
Sales Integer   Number of Sales
Go Integer   Number of Go Events
Calls Integer   Number of Call Events
Commissions Currency (USD) $0.00 Total Commission
Funded Comm. Currency (USD) $0.00 Funded Commission
EPM Currency (USD) $0.00 Earnings Per 1000 Impressions
EPC Currency (USD) $0.00 Earnings Per 100 Clicks
EPS Currency (USD) $0.00 Earnings Per Sale
EPL Currency (USD) $0.00 Earnings Per Lead
EPc Currency (USD) $0.00 Earnings Per Click
CTR Percent 0.00% Click Through Rate
CR Percent 0.00% Conversion Rate
cPS Decimal   Clicks per Sale
cPL Decimal   Clicks per Lead
cPA Decimal   Clicks per Action


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.