Skip to main content

MerchantReport

Updated

Access:

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

Description:

This module provides direct access to the same reporting functionality that is provided by logging into your merchant account at www.avantlink.com. In addition to your merchant 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
  • 9 - Performance Summary By Ad Tool
  • 15 - Performance Summary By Affiliate
  • 25 - Performance Summary By Affiliate Tag Group
  • 20 - Performance Summary By Affiliate Website
  • 22 - Performance Summary By Custom Tracking Code
  • 12 - Performance Summary By Day
  • 29 - Performance Summary By Hour
  • 48 - Performance Summary By Month
  • 50 - Performance Summary By Week
  • 31 - Performance Summary By Product Ad Tools
  • 77 - Performance Summary By Paid Placement
  • 96 - Performance Summary By Sub Affiliate Partner
  • 63 - Calendar Period Trending
  • 65 - Calendar Period Trending By Affiliate
  • 66 - Calendar Period Trending By Affiliate Website
  • 67 - Rolling Period Trending
  • 69 - Rolling Period Trending By Affiliate
  • 70 - Rolling Period Trending By Affiliate Website
  • 2 - Ad Impressions (Summary)
  • 3 - Ad Impressions (Detail)
  • 5 - Click Throughs (Summary)
  • 6 - Click Throughs (Detail)
  • 79 - Affiliate Domain By Affiliate
  • 72 - Last Click Through to Sale Summary
  • 83 - First Click Through to Sale Summary
  • 8 - Sales/Commissions (Detail)
  • 18 - Products Sold
  • 19 - Sale Hit Tracking Trails
  • 16 - Datafeed Download Summary
  • 35 - Affiliate Email Summary
  • 23 - Invalid Affiliate Links
  • 44 - Paid Search Review

 

Supported Output Formats:

  • csv
  • html
  • tab
  • xml

Parameters:

  • 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.
  • merchant_id
    • Type: integer
    • Required: true
    • Description: An AvantLink assigned merchant identifier.
  • module
    • Type: string
    • Required: true
    • Description: For this module, specify "MerchantReport".
  • report_id
    • Type: integer
    • Required: true
    • Description: The numeric identifier of an AvantLink report.
  • affiliate_group_id
    • Type: integer
    • Required: false
    • Description: The numeric identifier of a custom affiliate grouping.
  • affiliate_id
    • Type: integer
    • Required: false
    • Description: An AvantLink assigned affiliate identifier.
  • 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.
  • 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.
  • 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.

Related articles