Skip to content
MCP tools
View as Markdown
Read-onlyReferralsMCP tool

referrals_stats

Get aggregate statistics for referrals: total count, counts by status, total fees earned, total fees pending.

Get aggregate statistics for referrals: total count, counts by status, total fees earned, total fees pending. Use this for dashboard metrics. Does NOT return individual records - use referrals_list for that.

Parameters#

ParameterTypeRequiredDescription
periodenumNoTime period for stats (default: 1_month) · One of: 1_day, 1_week, 1_month, 3_months, 1_year, ytd, all

Example prompts#

  • "How much referral income have I earned year to date, and what is pending?"
  • "Give me a breakdown of my referrals by status for the last three months."

Safety#

Read-only. This tool never changes your data — it only looks things up. Safe to run anytime.