API Reference

Get payout-eligible attributed volume and revenue by referral level

get
https://api.fuul.xyz/api/v1/affiliate-portal/paid-volumes-by-level

Sums payout-eligible attributions by referral level (L1–L4). Volume and revenue come from attribution total_volume_amount_usd and total_revenue_amount_usd (USD-normalized basis used in analytics); payout_eligible_*_attributions are counts. Project-wide aggregates (no conversion filter). Response fields are plain numbers—no currency object in the payload.

Required API Key Scope: service_role

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

The identifier of the affiliate

date

Start of date range (YYYY-MM-DD); use with to.

date

End of date range (YYYY-MM-DD); use with from.

string
enum

Set to true for the current calendar month.

Allowed:
Responses

400

Bad Request - Invalid user_identifier, or this_month used together with from/to

401

Unauthorized - Missing or invalid API key, or insufficient scope

404

Not Found - Affiliate not found for this project

Updated 2 months ago

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

Updated 2 months ago

Did this page help you?