ReferenceAgencies

Get chatter leaderboard

Returns per-chatter performance metrics for the authenticated user's agency over a specified time period. Each row includes message volume, PPV sends and unlocks, revenue, derived ratios (golden ratio, unlock ratio), active hours, earnings per active hour, and average response time. Rows are sorted by revenue descending. Stats are sourced from the daily aggregation table and are refreshed at most once per day, so very recent activity may not be reflected. <Info>Scope required: `read:agency`</Info> <Info>Requires: Agency admin access</Info>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Fanvue-API-VersionstringRequiredDefaults to 2025-06-26
API version to use for the request

Query parameters

startDatestringOptionalformat: "date-time"

Start date as ISO 8601 datetime string with optional timezone offset (e.g., 2024-10-20T00:00:00+01:00 or 2024-10-20T00:00:00Z). Stats are aggregated by UTC day.

endDatestringOptionalformat: "date-time"

End date as ISO 8601 datetime string with optional timezone offset (e.g., 2024-10-25T00:00:00+01:00 or 2024-10-25T00:00:00Z). Stats are aggregated by UTC day.

chatterUuidsstringOptional

Comma-separated chatter UUIDs to filter by (max 100). Defaults to all chatters in the agency.

Response

Chatter leaderboard data
datalist of objects

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
410
Gone Error
429
Too Many Requests Error