Get payouts and volumes by referrer

Returns an array of objects whose keys are referred-user identifiers under the given referrer (user_identifier query = that referrer). Each value includes total volume, L1 earnings, payout-eligible volumes, and multilevel commission for that referred user (L1 branch).

Omit both from_date and to_date for all-time totals. When both are set (ISO 8601, inclusive), volume, earnings, direct_eligible_volume, indirect_eligible_volume, and total_commission_earned are limited to that window using daily aggregates; date_joined remains all-time. Sending only one of the two returns 400.

volume is total attributed volume for the direct referred user. direct_eligible_volume and indirect_eligible_volume only include volume from attributions that generated confirmed referrer payouts (referrer_amount > 0) at L1 and L2–L4 respectively. earnings is L1 commission only; total_commission_earned is L1 plus L2–L4 commission by currency for that L1 branch.

By default (referrer_scope=active or omitted), only referred users with volume, earnings, eligible volume, or commission are returned. Use referrer_scope=all to also include referred users that only exist in user_referrers (no attributions yet), with zeros and empty arrays.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

The referrer identifier to filter by (returns data per referred user under this referrer)

string
enum
required

The type of identifier being used

Allowed:
string
enum
Defaults to active

active (default) — only referred users with attributions volume or payouts. all — also include dormant referred users (only in user_referrers).

Allowed:
date

Inclusive range start (ISO 8601). Required together with to_date when filtering; omit both for all-time totals.

date

Inclusive range end (ISO 8601). Required together with from_date when filtering; omit both for all-time totals.

Responses

400

Bad Request - Invalid parameters

401

Unauthorized - Missing or invalid API key

404

Not Found - No payouts found for referrers

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json