List chatter earnings by creator (cursor-paginated)

Changed on

Returns one row per chatter and creator for the authenticated user's agency over the requested period: what each chatter earned on each creator, for payroll. The rows come from the same read as the earnings leaderboard breakdown, so the two always agree.

Earnings are attributed to the purchase date. revenue is ppvRevenue plus tipsRevenue, all gross USD cents. A tip is credited to the chatter who sent the last 1:1 message in that chat shortly before it was paid. Refunds and chargebacks are reported in their own fields and never subtracted. Net figures are after the Fanvue fee.

Chatters whose accounts are deleted or banned, and tips credited to no chatter, are not returned, so the rows alone do not sum to the agency's total chat earnings. totals does include them: it is the same for every page and equals the leaderboard's totals for the same filters and period.

Rows are ordered by revenue descending. Page with the opaque nextCursor from the previous response, keeping the same filters. Pages are re-read on every request, so a period that includes the current day can shift between pages as new sales land; request a period that has ended for a stable payroll export. Without both startDate and endDate the period is all time. Agencies without the chatter earnings breakdown enabled get a 404. <Info>Requires: Agency admin access</Info>

get/agencies/insights/chatter-earnings

Request

  • Base URL
    https://api.fanvue.com
  • URL
    https://api.fanvue.com/agencies/insights/chatter-earnings
  • Auth
    OAuth 2
    Authorization code: https://auth.fanvue.com/oauth2/auth
    Token URL: https://auth.fanvue.com/oauth2/token scopes: read:agency

Query parameters

cursorstring

Opaque pagination cursor from a previous response's nextCursor. Omit to fetch the first page.

sizeinteger

Number of items to return (1-50, default: 15)

startDatestring 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.

endDatestring 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.

chatterUuidsstring

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

creatorUuidstring uuid

UUID of one of the agency's creators to restrict rows to. A creator outside the agency fails the request with 403. Defaults to every creator.

Headers

X-Fanvue-API-Versionstring required
Example:2025-06-26

API version to use for the request

Response

Cursor-paginated chatter earnings by creator

nextCursorstring nullable required

Opaque cursor for the next page, or null when there are no more results

totalinteger nullable required

Total number of items across all pages, or null when no count is computed

Changes