Skip to main content
GET
Get dynamic smart list dimensions
Required scopes
  • read:chat — Read chat conversations, messages, and chat-related data. This includes viewing chat lists and message history.
  • read:fan — Access fan-related data and information within the platform.

Authorizations

Authorization
string
header
required

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.

Headers

X-Fanvue-API-Version
string
default:2025-06-26
required

API version to use for the request

Example:

"2025-06-26"

Response

Dimension manifest

key
string
required
labelKey
string
required
category
string
required
valueType
string
required
operators
string[]
required
store
string
required
enumOptions
object[]

Other stored values this option also represents

maxValue
number

Largest value the builder accepts (seconds for time windows); on money dimensions this caps the optional withinSeconds and olderThanSeconds windows

withinSecondsPresets
number[]

Rolling window choices (seconds) for count_within_days dimensions

supportsMinAmount
boolean

Whether this recency dimension also accepts { seconds, minAmount }

supportsAllTime
boolean

Whether the window may be left out, meaning all time: { count } on count_within_days, { minAmount, amountOperator? } on days dimensions with supportsMinAmount

{key}
any