Skip to main content

MerchantParentReport

Updated

Access:

Merchant Parent 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 Parent account at www.avantlink.com. In addition to your Retail Parent 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
  • 15 - Performance Summary By Affiliate
  • 25 - Performance Summary By Affiliate Grouping
  • 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
  • 31 - Performance Summary By Product
  • 77 - Performance Summary By Paid Placement
  • 9 - Performance Summary By Tool Type
  • 50 - Performance Summary By Week
  • 63 - Calendar Period Trending
  • 65 - Calendar Period Trending By Affiliate
  • 66 - Calendar Period Trending By Affiliate Website
  • 64 - Calendar Period Trending By Merchant
  • 67 - Rolling Period Trending
  • 69 - Rolling Period Trending By Affiliate
  • 70 - Rolling Period Trending By Affiliate Website
  • 68 - Rolling Period Trending By Merchant
  • 2 - Ad Impressions (Summary)
  • 3 - Ad Impressions (Detail)
  • 5 - Click Throughs (Summary)
  • 6 - Click Throughs (Detail)
  • 79 - Referral Domain By Affiliate
  • 72 - Last Click Through to Sale Summary
  • 83 - First Click Through to Sale Summary
  • 11 - Performance Incentive Report
  • 8 - Sales/Commissions (Detail)
  • 19 - Sale Hit Tracking Trails
  • 18 - Sale Product Performance
  • 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_parent_id
    • Type: integer
    • Required: true
    • Description: An AvantLink assigned Merchant Parent identifier.
  • module
    • Type: string
    • Required: true
    • Description: For this module, specify "MerchantParentReport".
  • 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.
  • 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_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.
  • 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