Skip to main content

AffiliateQuickStatsBar

Updated

Access:

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

Description:

This module provides functionality to support a Mozilla Firefox/Thunderbird plug-in that displays AvantLink performance results in a status bar at the bottom of your browser or email client. It is not intended for use in external projects beyond this capacity.

Supported Output Formats:

  • html
  • xml

Parameters:

  • affiliate_id
    • Type: integer
    • Required: true
    • Description: An AvantLink assigned affiliate identifier.
  • application
    • Type: string
    • Required: true
    • Description: What application is this request from, i.e. "firefox" or "thunderbird"?
  • 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 "AffiliateQuickStatsBar".
  • operation
    • Type: string
    • Required: true
    • Description: What action are you requesting from this module? Options include "stats", "detail", "install", "version".
  • 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_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.
  • destination_url
    • Type: string
    • Required: false
    • Description: None available.
  • 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.
  • report_id
    • Type: integer
    • Required: false
    • Description: The numeric identifier of an AvantLink report.
  • website_id
    • Type: integer
    • Required: false
    • Description: An AvantLink assigned affiliate website identifier.

Related articles