Sign in
latestOpenAPI 3.1.02026-08-08243131.9 MB

c5ddcd5c7e72

Get unsubscribe reasons

Returns a breakdown of why fans are unsubscribing from the authenticated creator, based on exit-survey data.

This is the same fan-health data surfaced in the Creator Agent. It is aggregated weekly (not real-time): currentWeekCount covers the most recent snapshot period and rollingCount spans the last 12 weeks. Frame it as "based on the last 12 weeks of exit surveys" rather than live data.

Reasons returned: too_expensive, not_enough_content, content_not_expected, creator_not_active, and other. The *Total fields count all surveys in the window and may exceed the sum of the listed reasons.

get/insights/unsubscribe-reasons

Query parameters

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

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.

Headers

X-Fanvue-API-Versionstring required
Example:2025-06-26

API version to use for the request

Response

Unsubscribe reasons breakdown

currentWeekTotalinteger required

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

rollingTotalinteger required

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