Skip to main content
GET
Get the affiliate performance figures

Authorizations

X-API-Key
string
header
required

Query Parameters

days
integer
default:30

The window these figures cover.

Required range: 1 <= x <= 365

Response

Successful Response

Everything the affiliate overview measures over one window.

active_count
integer
required

Referrals still inside their commission window.

average_commission_cents
integer | null
required

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

clears_minimum_on
string<date> | null
required

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

clicks
AffiliateTrendReadSchema · object
required

One metric over a window, against the window immediately before it.

conversion_rate
number | null
required

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

conversions
AffiliateTrendReadSchema · object
required

One metric over a window, against the window immediately before it.

days
integer
required

The window length these figures cover.

earned_cents
AffiliateTrendReadSchema · object
required

One metric over a window, against the window immediately before it.

epc_cents
integer | null
required

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

held_cents
integer
required

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

last_commission_at
string<date-time> | null
required
last_conversion_at
string<date-time> | null
required
last_signup_at
string<date-time> | null
required
lifetime_clawed_back_cents
integer
required

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

lifetime_gross_cents
integer
required
lifetime_net_cents
integer
required
never_paid_count
integer
required

Referrals that have not started a paid plan.

next_payout_blocker
string | null
required

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

next_payout_cents
integer
required

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

next_payout_on
string<date>
required

The date of the next monthly payout run.

next_payout_status
enum<string>
required

Whether that run will actually send anything: scheduled, below the minimum, blocked on a step the affiliate can take, under human review, paused program-wide, or unavailable to this account.

Available options:
paused,
unavailable,
under_review,
blocked,
below_minimum,
scheduled
signup_rate
number | null
required

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

signups
AffiliateTrendReadSchema · object
required

One metric over a window, against the window immediately before it.

upcoming_maturities
AffiliateMaturityReadSchema · object[]
required

The next days pending commission becomes payable on, soonest first.

window_closed_count
integer
required

Referrals whose commission window has ended.