affiliate

Get the affiliate performance figures

The overview's whole measurement surface in one read: the click, signup, conversion and earnings funnel over a window with each step against the equally long window before it; the rates over those steps; lifetime gross, clawed-back and net commission; where the referral roster stands; when pending commission matures; and what the next monthly payout run would send. A rate whose denominator is too small to state honestly comes back null rather than as a number nobody should act on.

get/affiliate/performance/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/affiliate/performance/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Query parameters

daysinteger

The window these figures cover.

Response

Successful Response

active_countinteger required

Referrals still inside their commission window.

average_commission_centsinteger nullable required

Lifetime gross commission per paying referral. Null with none yet.

clears_minimum_onstring date nullable required

The day the payable balance first clears the payout minimum on that schedule. Null when it already has, or when it never does.

conversion_ratenumber nullable required

Paying referrals per signup, lifetime, 0-1. Null below the honesty floor.

daysinteger required

The window length these figures cover.

epc_centsinteger nullable required

Commission earned per click over the window. Null below the honesty floor.

held_centsinteger required

Money in a payout waiting on human review. Still counted in the available balance until it is released.

last_commission_atstring date-time nullable required
last_conversion_atstring date-time nullable required
last_signup_atstring date-time nullable required
lifetime_clawed_back_centsinteger required

What refunds and disputes took back, as a positive magnitude.

lifetime_gross_centsinteger required
lifetime_net_centsinteger required
never_paid_countinteger required

Referrals that have not started a paid plan.

next_payout_blockerstring nullable required

When blocked, which gate: identity_not_verified, no_payout_email or destination_hold.

next_payout_centsinteger required

What that run would send on today's numbers plus what matures before it.

next_payout_onstring date required

The date of the next monthly payout run.

next_payout_status'paused' | 'unavailable' | 'under_review' | 'blocked' | 'below_minimum' | 'scheduled' required

What the next monthly run will do with this affiliate's balance.

Derived from the same gates the payout engine applies, so the sentence the dashboard prints and the decision the run makes cannot disagree. Every "your payout goes out on the 1st" used to be unconditional, which made it false for a first payout (held for a human), a blocked affiliate (no identity check, no PayPal address, a fresh address inside its hold), a suspended or banned account, a balance under the minimum, and the whole period the program ships with payouts switched off.

signup_ratenumber nullable required

Signups per click over the window, 0-1. Null when there were too few clicks for the figure to mean anything.

window_closed_countinteger required

Referrals whose commission window has ended.

Changes

No recorded changes to this operation across all 1 revision of this API.