RemoteConfig

Properties

NameType
analytics{ endpoint?: string; }

Custom endpoint configuration for analytics events.

autocapture_opt_outboolean

If true, disables autocapture. When absent or not a boolean, the SDK keeps the last known server value; a visitor with no stored value keeps autocapture off until a response containing the field arrives.

autocaptureExceptionsboolean | { endpoint?: string; }

Exception autocapture configuration.

captureDeadClicksboolean

Whether to capture dead clicks.

capturePerformanceboolean | PerformanceCaptureConfig

Performance capture configuration shared by replay and web vitals.

conversationsboolean | ConversationsRemoteConfig

Conversations widget configuration.

defaultIdentifiedOnlyboolean

Whether to capture only identified users by default.

editorParamsToolbarParams

Deprecated: Renamed to toolbarParams; still present on older API responses.

elementsChainAsStringboolean

Whether $elements_chain is sent as a string rather than an array.

errorTracking{ autocaptureExceptions?: boolean; captureExtensionExceptions?: boolean; suppressionRules?: ErrorTrackingSuppressionRule[]; }

Error tracking configuration.

hasFeatureFlagsboolean

Whether the team has any feature flags enabled.

heatmapsboolean

Whether heatmaps are enabled.

isAuthenticatedboolean

Whether the current user is authenticated.

logs{ captureConsoleLogs?: boolean; }

Log capture configuration.

productToursboolean

Whether product tours are enabled.

sessionRecordingSessionRecordingRemoteConfig | false

Session recording configuration.

siteApps{ id: string; url: string; }[]

Site apps available to the client.

supportedCompressionCompression[]

Supported compression algorithms.

surveysboolean | Survey[]

Whether surveys are enabled, optionally including their definitions.

toolbarParamsToolbarParams

Parameters for the toolbar.

toolbarVersion'toolbar'

Deprecated: Moved to toolbarParams.