Recommendation Object
Recommendation Object
uuid
String
Recommendation UUID.
type
String
free or paid.
status
String
Recommendation status (e.g. active, awaiting_approval, archived).
name
String
Display name of the recommended publication.
last_30_days_confirmation_rate
Number
Referral confirmation rate over the last 30 days.
role
String
Free only. sending or receiving, relative to the publication in the path.
recommended_publication
String | Object
The recommended publication's UUID; the full Publication Object with expand=recommended_publication.
recommending_publication
String | Object
Free only. The sending publication's UUID; the full Publication Object with expand=recommending_publication.
commission
Number
Paid only. Commission earned per referral.
max_payout
Number | null
Paid only. Per-cycle payout cap.
partner_program_uuid
String | null
Paid only. The backing partner program.
stats
Object
Date-ranged performance. Present only with expand=stats.
stats (only with expand=stats)
By default, stats is a flat object:
referrals
Object
confirmed, pending, total referral counts.
earnings
Object
Paid only. confirmed, estimated_pending, total in dollars.
Grouped stats (show only, with stats_grouped_by)
On Get recommendation (Earn) or Get free recommendation (Grow), pass stats_grouped_by=utm_source, utm_campaign, or country_code with expand=stats to get the same stats shape nested under each group key. Results are capped at the top 50 groups by referral volume. Blank or missing values appear under "none". Optionally pass stats_group_value to return a one-key map for that group only. Free recommendations nest only the referrals block (no earnings).
Example (paid, expand=recommended_publication,stats)
Example (paid, expand=stats&stats_grouped_by=utm_source)
Example (free, receiving)
Example (free, expand=stats&stats_grouped_by=utm_source)