statsAffiliateToplist
Syntax
statsAffiliateToplist(from, to, affiliate, currency='')
Returns the list of your affiliates sorted by sales.
In doing so, you select the period for which the sales should be displayed.
The list contains all affiliates who have generated sales in the selected period.
Access rights
Read access or full access required.
Arguments
from – month, e.g. 2015-01
to – month, e.g. 2015-12
affiliate (optional) – Digistore id of an affiliate
currency (optional) –currency code to show the revenue for. Defaults to the api key's owner's default currency. Example values: USD, EUR, GBP, CHF, PLN.
Return data
top_list: List of sales. The following values are displayed for each affiliate:
- affiliate_id: numerical ID of the affiliate
- affiliate_name: Digistore ID of the affiliate (in text form)
- currency: currency (e.g.: EUR, USD)
- brutto_amount: gross sales of the affiliate
- netto_amount: net sales of the affiliate
- payment_amount: Total of all payments (gross)
- refund_amount: Total of all refunds
- chargeback_amount: Total of all chargebacks
- cancellation_amount: Total of all refunds and chargebacks
- affiliate_amount: Payout amount for the affiliate
- merchant_amount: Payout amount for you as vendor
- refund_quota: Refund quota
- chargeback_quota: Chargeback quota
- cancellation_quota: Cancellation quota (taking into account refunds and chargebacks)
Was this helpful?