AvantLink API - Main
Affiliate Modules:
Data Retrieval
Subscription Configuration
Used By AvantLink Tools
Merchant Modules:
Data Input
Data Retrieval
Used By AvantLink Tools
Merchant Parent Modules:
Data Retrieval
Used By AvantLink Tools
|
Avantlink API Module: AffiliateReportRss
Access:
Affiliate authentication required, secure connections (https://) only.
Frequency limitation(s): 100 request(s) per day.
Description:
This module provides RSS access to the same reporting functionality
that is provided by logging into your Affiliate account at
classic.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
- 9 - Performance Summary By Ad Tool
- 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 Tag Group
- 48 - Performance Summary By Month
- 77 - Performance Summary By Paid Placement
- 31 - Performance Summary By Product Ad Tools
- 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
Additionally, you must request a named date range (rather than
custom/manually specified date ranges) for the report so that subsequent
refreshes of your RSS account will be able to retrieve new data
automatically.
Supported Output Formats:
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 "AffiliateReportRss".
- 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.
- 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.
|