Skip to main content
GET
Get fan insights
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"

Path Parameters

userUuid
string<uuid>
required

Fan's UUID

Response

Fan insights data

status
enum<string>
required

Current fan status. subscriber has a current subscription, expired had one that ended, follower follows without subscribing, and not_contactable is none of those but has paid this creator before or has a conversation in their inbox (for example a fan who tipped and then unfollowed). A fan with no subscription, no follow, no purchase and no conversation with this creator is not connected, so the single-fan endpoints return 404, GET /insights/fans returns a null result plus a NOT_FOUND entry in errors, and POST /insights/fans/batch maps the fan to { "error": "not_found" }.

Available options:
subscriber,
expired,
follower,
not_contactable
spending
object
required
subscription
object
required