RemoteConfig
Properties
Name | Type |
---|---|
analytics | {
endpoint?: string;
} |
Whether we should use a custom endpoint for analytics endpoint: "/e" | |
autocapture_opt_out | boolean |
If set, disables autocapture | |
autocaptureExceptions | boolean | {
endpoint?: string;
} |
This is currently in development and may have breaking changes without a major version bump | |
captureDeadClicks | boolean |
Whether to capture dead clicks | |
capturePerformance | boolean | 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 | |
defaultIdentifiedOnly | boolean |
Whether to only capture identified users by default | |
editorParams | ToolbarParams |
elementsChainAsString | boolean |
Whether the | |
errorTracking | {
autocaptureExceptions?: boolean;
suppressionRules?: ErrorTrackingSuppressionRule[];
} |
Error tracking configuration options | |
hasFeatureFlags | boolean |
Indicates if the team has any flags enabled (if not we don't need to load them) | |
heatmaps | boolean |
Whether heatmaps are enabled | |
isAuthenticated | boolean |
Whether the user is authenticated | |
sessionRecording | SessionRecordingCanvasOptions & {
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 | |
supportedCompression | Compression[] |
Supported compression algorithms | |
surveys | boolean | Survey[] |
Whether surveys are enabled | |
toolbarParams | ToolbarParams |
Parameters for the toolbar | |
toolbarVersion | 'toolbar' |
deprecated, moved to toolbarParams |