> ## 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 fan insights

> Returns detailed insights about a specific fan for the authenticated creator, including spending statistics, subscription status, and fan engagement metrics.

<Info>
  **Required scopes**

  * `read:insights` — Access analytics, metrics, and insights data for performance tracking.
  * `read:fan` — Access fan-related data and information within the platform.
</Info>


## OpenAPI

````yaml /openapi.json get /insights/fans/{userUuid}
openapi: 3.1.0
info:
  title: Fanvue API
  version: '0.1'
servers: []
security: []
paths:
  /insights/fans/{userUuid}:
    get:
      summary: Get fan insights
      description: >-
        Returns detailed insights about a specific fan for the authenticated
        creator, including spending statistics, subscription status, and fan
        engagement metrics.
      operationId: getFanInsights
      parameters:
        - $ref: '#/components/parameters/ApiVersionHeader'
        - schema:
            type: string
            format: uuid
            description: Fan's UUID
          required: true
          description: Fan's UUID
          name: userUuid
          in: path
      responses:
        '200':
          description: Fan insights data
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - subscriber
                      - expired
                      - follower
                      - not_contactable
                    description: Current fan status
                  spending:
                    type: object
                    properties:
                      lastPurchaseAt:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        description: >-
                          Date of last purchase (ISO 8601) or null if no
                          purchases
                      total:
                        type: object
                        properties:
                          gross:
                            type: number
                            description: >-
                              DEPRECATED: use `total`. Total amount this fan
                              paid across all transactions, in USD cents. Same
                              value as `total`.
                          total:
                            type: number
                            description: >-
                              Total amount this fan paid across all
                              transactions, in USD cents
                        required:
                          - gross
                          - total
                      maxSinglePayment:
                        type: object
                        properties:
                          gross:
                            type: number
                            description: >-
                              DEPRECATED: use `total`. Largest single payment
                              this fan made, in USD cents. Same value as
                              `total`.
                          total:
                            type: number
                            description: Largest single payment this fan made, in USD cents
                        required:
                          - gross
                          - total
                      sources:
                        type: object
                        additionalProperties:
                          type: object
                          properties:
                            gross:
                              type: number
                              description: >-
                                DEPRECATED: use `total`. Total amount paid by
                                the fan for this source type, in USD cents. Same
                                value as `total`.
                            total:
                              type: number
                              description: >-
                                Total amount paid by the fan for this source
                                type, in USD cents
                          required:
                            - gross
                            - total
                        description: Breakdown of spending by source
                    required:
                      - lastPurchaseAt
                      - total
                      - maxSinglePayment
                      - sources
                  subscription:
                    type: object
                    properties:
                      createdAt:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        description: >-
                          Date subscription was created (ISO 8601) or null if no
                          subscription
                      renewsAt:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        description: >-
                          Date subscription renews (ISO 8601) or null if no
                          active subscription
                      autoRenewalEnabled:
                        type: boolean
                        description: Whether fan has active recurring subscription
                    required:
                      - createdAt
                      - renewsAt
                      - autoRenewalEnabled
                required:
                  - status
                  - spending
                  - subscription
              example:
                status: subscriber
                spending:
                  lastPurchaseAt: '2024-01-14T00:00:00.000Z'
                  total:
                    gross: 27700
                    total: 27700
                  maxSinglePayment:
                    gross: 5000
                    total: 5000
                  sources:
                    message:
                      gross: 15000
                      total: 15000
                    post:
                      gross: 8500
                      total: 8500
                    referral:
                      gross: 4200
                      total: 4200
                subscription:
                  createdAt: '2024-01-01T12:00:00.000Z'
                  renewsAt: '2024-02-01T00:00:00.000Z'
                  autoRenewalEnabled: true
        '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'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '410':
          $ref: '#/components/responses/SunsetVersionResponse'
        '429':
          $ref: '#/components/responses/RateLimitResponse'
      security:
        - BearerAuth:
            - read:insights
            - read:fan
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
    NotFoundResponse:
      description: Not Found Response
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
            required:
              - message
    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.

````