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: MerchantReportRss
Access:
Merchant 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 Merchant account at
classic.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
- 77 - Performance Summary By Paid Placement
- 31 - Performance Summary By Product Ad Tools
- 96 - Performance Summary By Sub Affiliate Partners
- 50 - Performance Summary By Week
- 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
- 85 - Affiliate Application Approvals
- 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
- 8 - Sales/Commissions (Detail)
- 19 - Sale Hit Tracking Trails
- 16 - Datafeed Download Summary
- 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:- 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 "MerchantReportRss".
- 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_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.
- report_id
- Type: integer
- Required: false
- Description: The numeric identifier of an AvantLink report.
|