Skip to main content
GET
Get fan retention summary
Required scope
  • read:insights — Access analytics, metrics, and insights data for performance tracking.

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

periods
integer
default:6

Number of most-recent weekly snapshots to return (1-12, default: 6)

Required range: 1 <= x <= 12

Response

Weekly fan retention snapshots

snapshots
object[]
required

Weekly fan-health snapshots, most recent first