AffiliateReport

Access:

Affiliate authentication required, secure connections (https://) only.
Frequency limitation(s): 1000 request(s) per day.

Description:

This module provides direct access to the same reporting functionality that is provided by logging into your Affiliate account at www.avantlink.com. In addition to your Affiliate authentication information, you must provide a value for the "report_id" parameter, from the following list:

  • 1 - Performance Summary
  • 24 - Performance Summary By Ad Campaign
  • 20 - Performance Summary By Affiliate Website
  • 22 - Performance Summary By Custom Tracking Code
  • 12 - Performance Summary By Day
  • 29 - Performance Summary By Hour
  • 33 - Performance Summary By Merchant Grouping
  • 48 - Performance Summary By Month
  • 31 - Performance Summary By Product
  • 77 - Performance Summary By Paid Placement
  • 9 - Performance Summary By Tool Type
  • 50 - Performance Summary By Week
  • 2 - Ad Impressions (Summary)
  • 3 - Ad Impressions (Detail)
  • 5 - Click Throughs (Summary)
  • 6 - Click Throughs (Detail)
  • 72 - Last Click Through to Sale Summary
  • 83 - First Click Through to Sale Summary
  • 8 - Sales/Commissions (Detail)
  • 19 - Sale Hit Tracking Trails
  • 81 - Datafeeds: Merchant Datafeed Quality
  • 47 - Merchant Ranking By Earnings
  • 23 - Invalid Affiliate Links

 

Supported Output Formats:

  • csv
  • html
  • tab
  • xml

Parameters:

  • affiliate_id
    • Type: integer
    • Required: true
    • Description: An AvantLink assigned Affiliate identifier.
  • auth_key
    • Type: string
    • Required: true
    • Description: The AvantLink assigned authentication key for a particular Affiliate or Merchant. This is a randomly generated, 32-character, mixed alphanumeric string.
  • module
    • Type: string
    • Required: true
    • Description: For this module, specify "AffiliateReport".
  • report_id
    • Type: integer
    • Required: true
    • Description: The numeric identifier of an AvantLink report.
  • custom_tracking_code
    • Type: string
    • Required: false
    • Description: A custom string to be appended to AvantLink click-through URLs, for use with your own personal tracking mechanisms.
  • date_begin
    • Type: date
    • Required: false
    • Description: For custom date ranges, the start of the date range. Must be specified in "yyyy-mm-dd hh:ii:ss" format.
  • date_end
    • Type: date
    • Required: false
    • Description: For custom date ranges, the end of the date range. Must be specified in "yyyy-mm-dd hh:ii:ss" format
  • date_range
    • Type: string
    • Required: false
    • Description: A named date range. If specified, this takes precedence over a custom date range. Valid values are: Today, Yesterday, Prev7Days, ThisMonth, LastMonth, ThisYear.
  • include_inactive_merchants
    • Type: boolean
    • Required: false
    • Description: A boolean value to indicate whether or not to include inactive Merchant programs in the report results (1 = yes, 0 = no). The default behavior is to NOT include inactive Merchants.
  • merchant_group_id
    • Type: integer
    • Required: false
    • Description: The numeric identifier of a custom Merchant grouping.
  • merchant_id
    • Type: integer
    • Required: false
    • Description: An AvantLink assigned Merchant identifier.
  • output
    • Type: string
    • Required: false
    • Description: The specific output format you wish to receive results in. Possible values include: csv (comma-separated text), html, js (javascript document.write statements), rss, tab (tab-delimited text), and xml (the default). Individual modules may not support all output methods.
  • search_results_include_cpc
    • Type: boolean
    • Required: false
    • Description: A boolean value to indicate whether to include individual CPC data (1 = yes, 0 = no). This parameter is only valid when requesting the Sales/Commissions (Detail) report.
  • send_as_attachment
    • Type: boolean
    • Required: false
    • Description: A boolean value indicating whether the report should be sent as an attachment to an email (1 = yes, 0 = no).
  • send_email
    • Type: boolean
    • Required: false
    • Description: A boolean value to indicate whether an email response should be generated by this API request (1 = yes, 0 = no).
  • tool_type
    • Type: string
    • Required: false
    • Description: An abbreviation for a particular type of AvantLink tool.
  • transaction_id
    • Type: string
    • Required: false
    • Description: A sales transaction id, a.k.a. order id.
  • website_id
    • Type: integer
    • Required: false
    • Description: An AvantLink assigned affiliate website identifier.
Have more questions? Submit a request
Powered by Zendesk