Skip to main content
GET
Get unsubscribe reasons
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

periodStart
string<date-time>

ISO 8601 datetime anchoring the current-week window. Counts are aggregated on weekly fan-health snapshots, so this is snapped to the snapshot boundary. If omitted, defaults to the most recent snapshot period.

Response

Unsubscribe reasons breakdown

reasons
object[]
required

Per-reason counts. Based on exit surveys, aggregated weekly — not real-time.

currentWeekTotal
integer
required

Total exit surveys in the most recent snapshot week (across all reasons)

rollingTotal
integer
required

Total exit surveys across the last 12 weeks (across all reasons)