> ## 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 tracking metadata for a user

> Get the custom tracking metadata from a user's most recent impression on a tracking link.

Metadata is captured from the query string of the shared short link (`https://www.fanvue.com/<handle>/fv-3?campaign=spring_launch`), using plain query parameters rather than the `metadata[<key>]` syntax checkout links use. Every non-reserved parameter is captured as-is, trimmed to 10 keys and 500 characters per value; over-limit input is silently trimmed rather than rejected.

Only the most recent impression is returned, and metadata is never merged across clicks: a later click replaces the previous values wholesale, and a later click with no query parameters returns `null`.

Returns 404 when the link is not one of the creator's, and 200 with `metadata: null` when the user has no attributed impression carrying usable metadata.

See the [tracking links guide](https://api.fanvue.com/docs/tutorials/tracking-links) for the full mechanism, limits and worked examples.

<Info>
  **Required scope**

  * `read:tracking_links` — Read tracking links and the users associated with them, including per-user tracking metadata.
</Info>


## OpenAPI

````yaml /openapi-v1.json get /v1/tracking-links/{uuid}/users/{userUuid}/metadata
openapi: 3.1.0
info:
  title: Fanvue API
  version: '0.1'
servers:
  - url: https://api.fanvue.com
security: []
paths:
  /v1/tracking-links/{uuid}/users/{userUuid}/metadata:
    get:
      summary: Get tracking metadata for a user
      description: >-
        Get the custom tracking metadata from a user's most recent impression on
        a tracking link.


        Metadata is captured from the query string of the shared short link
        (`https://www.fanvue.com/<handle>/fv-3?campaign=spring_launch`), using
        plain query parameters rather than the `metadata[<key>]` syntax checkout
        links use. Every non-reserved parameter is captured as-is, trimmed to 10
        keys and 500 characters per value; over-limit input is silently trimmed
        rather than rejected.


        Only the most recent impression is returned, and metadata is never
        merged across clicks: a later click replaces the previous values
        wholesale, and a later click with no query parameters returns `null`.


        Returns 404 when the link is not one of the creator's, and 200 with
        `metadata: null` when the user has no attributed impression carrying
        usable metadata.


        See the [tracking links
        guide](https://api.fanvue.com/docs/tutorials/tracking-links) for the
        full mechanism, limits and worked examples.
      operationId: getUserTrackingMetadata
      parameters:
        - $ref: '#/components/parameters/ApiVersionHeader'
        - schema:
            type: string
            format: uuid
            description: Tracking link UUID
          required: true
          description: Tracking link UUID
          name: uuid
          in: path
        - schema:
            type: string
            format: uuid
            description: User UUID
          required: true
          description: User UUID
          name: userUuid
          in: path
      responses:
        '200':
          description: User's tracking metadata
          content:
            application/json:
              schema:
                type: object
                properties:
                  metadata:
                    type:
                      - object
                      - 'null'
                    additionalProperties:
                      type: string
                    description: >-
                      Custom metadata from the user's most recent impression on
                      this link, captured from the query string of the shared
                      short link. Null when the user has no attributed
                      impression carrying usable metadata, including when their
                      latest click carried no query parameters.
                required:
                  - metadata
              example:
                metadata:
                  lead_id: xyz123
                  source: snapchat
                  conversation_id: abc456
        '400':
          description: >-
            Bad Request - API version not supported OR validation failed OR
            invalid UUID
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/UnsupportedVersionError'
                  - $ref: '#/components/schemas/ValidationError'
                  - $ref: '#/components/schemas/InvalidUuidError'
        '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:tracking_links
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
    InvalidUuidError:
      type: object
      properties:
        message:
          type: string
      required:
        - message
      description: Invalid UUID format provided
  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.

````