📊Referred metrics

Referred users for a specific affiliate

The getPayoutsByReferrer method retrieves payout and volume information of the referred users for a specific affiliate.

const results = await Fuul.getPayoutsByReferrer({
user_identifier: '0x12345',
user_identifier_type: UserIdentifierType.EvmAddress
});

It returns an object where each key is a referred user and each value contains:

• Volume generated

• Earnings attributed to the referrer

Referred volume for a set of users

The getReferredVolume method retrieves the referred volume for a list of users.

const results = await Fuul.getReferredVolume({
    user_identifiers: ['0x1234...', '0x5678...'],
    identifier_type: UserIdentifierType.EvmAddress // same identifier_type for all user_identifiers
});

Referred Volume Leaderboard

To get the referred volume leaderboard check the Getting Leaderboard Data -> Volume section of the documentation.

You'll need to call the method with the user_type = 'affiliate'.

🔈Volume