cello_get_referrers
Finds referrers of your product and returns aggregated engagement and performance metrics, optionally filtered and sorted. Returns up to 10 referrers per page. Use when a user wants to find a specific referrer by email, UCC, product user id, or referrer id — or when they want referrers ranked by a specific metric like signups, revenue, or sharing activity.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number (1-indexed; page 1 returns the first 10 referrers, page 2 the next 10, etc.). Only specify when more than 10 referrers are needed. Omit for the first 10. | |
| sort | No | Sort referrers by engagement or performance metrics (descending). Available options: daysActive (number of days the referrer has been active), daysSharing (number of days the referrer has been sharing), lastActive (when the referrer was last active), referralAnnualRecurringRevenue (Net New Annual Recurring Revenue generated), referralRecurringPurchases (total number of purchases), referralRevenue (total revenue amount), referralSignups (total number of signups), referralViewsUnique (number of unique views from new users). | |
| filter | No | Filter by email, UCC, product user id, or referrer id |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| items | Yes | ||
| total | Yes |