> ## Documentation Index > Fetch the complete documentation index at: https://api.fanvue.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # 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. **Required scope** * `read:insights` — Access analytics, metrics, and insights data for performance tracking. ## OpenAPI ````yaml /openapi.json get /insights/unsubscribe-reasons openapi: 3.1.0 info: title: Fanvue API version: '0.1' servers: [] security: [] paths: /insights/unsubscribe-reasons: get: summary: Get unsubscribe reasons description: >- 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. operationId: getUnsubscribeReasons parameters: - $ref: '#/components/parameters/ApiVersionHeader' - schema: type: string format: date-time description: >- 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. required: false description: >- 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. name: periodStart in: query responses: '200': description: Unsubscribe reasons breakdown content: application/json: schema: type: object properties: reasons: type: array items: type: object properties: reason: type: string description: >- Exit-survey reason. One of: too_expensive, not_enough_content, content_not_expected, creator_not_active, other. currentWeekCount: type: integer description: >- Number of fans citing this reason in the most recent snapshot week rollingCount: type: integer description: >- Number of fans citing this reason across the last 12 weeks required: - reason - currentWeekCount - rollingCount description: >- Per-reason counts. Based on exit surveys, aggregated weekly — not real-time. currentWeekTotal: type: integer description: >- Total exit surveys in the most recent snapshot week (across all reasons) rollingTotal: type: integer description: >- Total exit surveys across the last 12 weeks (across all reasons) required: - reasons - currentWeekTotal - rollingTotal example: reasons: - reason: too_expensive currentWeekCount: 3 rollingCount: 28 - reason: not_enough_content currentWeekCount: 2 rollingCount: 19 - reason: content_not_expected currentWeekCount: 1 rollingCount: 11 - reason: creator_not_active currentWeekCount: 0 rollingCount: 6 - reason: other currentWeekCount: 1 rollingCount: 9 currentWeekTotal: 7 rollingTotal: 73 '400': description: >- Bad Request - API version not supported OR validation failed (dates, sources, cursor, pagination) content: application/json: schema: oneOf: - $ref: '#/components/schemas/UnsupportedVersionError' - $ref: '#/components/schemas/ValidationError' '401': $ref: '#/components/responses/UnauthorizedResponse' '403': $ref: '#/components/responses/UnauthorizedResponse' '410': $ref: '#/components/responses/SunsetVersionResponse' '429': $ref: '#/components/responses/RateLimitResponse' security: - BearerAuth: - read:insights components: parameters: ApiVersionHeader: name: X-Fanvue-API-Version in: header required: true schema: type: string default: '2025-06-26' example: '2025-06-26' description: API version to use for the request schemas: UnsupportedVersionError: type: object properties: error: type: string message: type: string required: - error - message description: API version not supported ValidationError: type: object properties: errors: type: array items: type: string required: - errors description: Request validation failed responses: UnauthorizedResponse: description: Unauthorized Response content: application/json: schema: type: object properties: error: type: string required: - error SunsetVersionResponse: description: API version no longer supported (sunset) content: application/json: schema: type: object properties: error: type: string message: type: string nextVersion: type: string required: - error - message RateLimitResponse: description: Too many requests - rate limit exceeded headers: Retry-After: description: Number of seconds to wait before retrying the request schema: type: integer X-RateLimit-Limit: description: The maximum number of requests allowed in the current window schema: type: integer X-RateLimit-Remaining: description: The number of requests remaining in the current window schema: type: integer X-RateLimit-Reset: description: The Unix timestamp (seconds) when the rate limit window resets schema: type: integer content: application/json: schema: type: object properties: error: type: string required: - error securitySchemes: BearerAuth: type: oauth2 description: >- 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. flows: authorizationCode: authorizationUrl: https://auth.fanvue.com/oauth2/auth tokenUrl: https://auth.fanvue.com/oauth2/token refreshUrl: https://auth.fanvue.com/oauth2/token scopes: read:self: >- Access your own user profile information, including basic account details and settings. read:chat: >- Read chat conversations, messages, and chat-related data. This includes viewing chat lists and message history. write:chat: >- Create new chats and send messages. This scope is required for any chat-related actions that modify data. read:experience: >- Exchange a fan's experience token for the resolved experience and the fan's identity, so an embedded fan-facing experience can render the right content. write:experience: >- Request that the creator publish or unpublish a fan-facing experience. The app mints a request token; the creator confirms and Fanvue performs the change. read:fan: Access fan-related data and information within the platform. read:post: Read posts, including post details, comments, likes, and tips. write:post: Create, edit, and manage posts and content on behalf of users. read:media: Access media files, images, videos, and other content assets. write:media: >- Upload, modify, and manage media files and content assets. Also required for vault folder management. read:creator: >- Access creator profiles, content, and creator-specific information. write:creator: Modify creator profiles, settings, and creator-specific data. read:insights: >- Access analytics, metrics, and insights data for performance tracking. read:tracking_links: >- Read tracking links and the users associated with them, including per-user tracking metadata. write:tracking_links: Create and delete tracking links. read:agency: Read agency information, including the agency's team members. write:agency: >- Manage agency team members and invites, including inviting new team members and creators. ````