Skip to main content
GET
List chatter earnings by creator (cursor-paginated)
Required scope
  • read:agency — Read agency information, including the agency’s team members.

Authorizations

Authorization
string
header
required

OAuth 2.0 access token, presented as a JWT bearer token in the Authorization header. Obtain a token via the authorization-code flow; the scopes granted to the token determine which operations it may call.

Headers

X-Fanvue-API-Version
string
default:2025-06-26
required

API version to use for the request

Example:

"2025-06-26"

Query Parameters

cursor
string

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

size
integer
default:15

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

Required range: 1 <= x <= 50
startDate
string<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.

endDate
string<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.

chatterUuids
string

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

creatorUuid
string<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.

Response

Cursor-paginated chatter earnings by creator

data
object[]
required

Array of chatter × creator rows, ordered by revenue descending

nextCursor
string | null
required

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

total
integer | null
required

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

totals
object
required

Every chatter's earnings summed for the filters, across all pages: the rows plus deleted or banned chatters and tips credited to no chatter. Equals the earnings leaderboard's totals for the same agency, filters and period.