Skip to main content
GET
Get top-spending fans (cursor-paginated)
Required scopes
  • read:insights — Access analytics, metrics, and insights data for performance tracking.
  • read:fan — Access fan-related data and information within the platform.

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

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

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). Non-inclusive - data before this date is included.

Response

Cursor-paginated list of top-spending fans

data
object[]
required

Top-spending fans, highest total spend first

nextCursor
string | null
required

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

total
number | null
required

Total number of items, or null when a count is not computed for this list