Get tracking metadata for a user on a creator's tracking link

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

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 for the full mechanism, limits and worked examples.

get/creators/{creatorUserUuid}/tracking-links/{uuid}/users/{userUuid}/metadata

Request

  • Base URL
    https://api.fanvue.com
  • URL
    https://api.fanvue.com/creators/{creatorUserUuid}/tracking-links/{uuid}/users/{userUuid}/metadata
  • Auth
    OAuth 2
    Authorization code: https://auth.fanvue.com/oauth2/auth
    Token URL: https://auth.fanvue.com/oauth2/token scopes: read:tracking_links, read:creator

Path parameters

creatorUserUuidstring uuid required
uuidstring uuid required

Tracking link UUID

userUuidstring uuid required

User UUID

Headers

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

API version to use for the request

Response

User's tracking metadata

metadataobject nullable required

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.

Changes

No recorded changes to this operation across all 8 revisions of this API.