RemoteConfig

Properties

NameType
analytics{ endpoint?: string; }

Whether we should use a custom endpoint for analytics endpoint: "/e"

autocapture_opt_outboolean

If set, disables autocapture

autocaptureExceptionsboolean | { endpoint?: string; }

This is currently in development and may have breaking changes without a major version bump

captureDeadClicksboolean

Whether to capture dead clicks

capturePerformanceboolean | PerformanceCaptureConfig

originally capturePerformance was replay only and so boolean true is equivalent to network_timing: true now capture performance can be separately enabled within replay and as a standalone web vitals tracker people can have them enabled separately they work standalone but enhance each other TODO: deprecate this so we make a new config that doesn't need this explanation

defaultIdentifiedOnlyboolean

Whether to only capture identified users by default

editorParamsToolbarParams
elementsChainAsStringboolean

Whether the $elements_chain property should be sent as a string or as an array false

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

Error tracking configuration options

hasFeatureFlagsboolean

Indicates if the team has any flags enabled (if not we don't need to load them)

heatmapsboolean

Whether heatmaps are enabled

isAuthenticatedboolean

Whether the user is authenticated

sessionRecordingSessionRecordingCanvasOptions & { endpoint?: string; consoleLogRecordingEnabled?: boolean; sampleRate?: string | null; minimumDurationMilliseconds?: number; linkedFlag?: string | FlagVariant | null; networkPayloadCapture?: Pick<NetworkRecordOptions, 'recordBody' | 'recordHeaders'>; masking?: Pick<SessionRecordingOptions, 'maskAllInputs' | 'maskTextSelector'>; urlTriggers?: SessionRecordingUrlTrigger[]; scriptConfig?: { script?: string | undefined; }; urlBlocklist?: SessionRecordingUrlTrigger[]; eventTriggers?: string[]; triggerMatchType?: 'any' | 'all'; }

Session recording configuration options

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

List of site apps with their IDs and URLs

supportedCompressionCompression[]

Supported compression algorithms

surveysboolean | Survey[]

Whether surveys are enabled

toolbarParamsToolbarParams

Parameters for the toolbar

toolbarVersion'toolbar'

deprecated, moved to toolbarParams

Community questions

Was this page useful?