SessionRecordingRemoteConfig

Properties

NameType
recordCanvasboolean

If set, records the canvas

canvasFpsnumber

If set, records the canvas at the given FPS Can be set in the remote configuration Limited between 0 and 12 When canvas recording is enabled, if this is not set locally, then remote config sets this as 4

canvasQualitystring

If set, records the canvas at the given quality Can be set in the remote configuration Must be a string that is a valid decimal between 0 and 1 When canvas recording is enabled, if this is not set locally, then remote config sets this as "0.4"

endpointstring
consoleLogRecordingEnabledboolean
sampleRatestring
minimumDurationMillisecondsnumber
linkedFlagstring | FlagVariant
networkPayloadCapturePick<NetworkRecordOptions, "recordBody" | "recordHeaders">
maskingPick<SessionRecordingOptions, "maskAllInputs" | "maskTextSelector" | "blockSelector" | "maskAllElementAttributes">
urlTriggersSessionRecordingUrlTrigger[]
scriptConfig{ script?: string | undefined; }
urlBlocklistSessionRecordingUrlTrigger[]
eventTriggersstring[]
triggerMatchType"any" | "all"

Controls how event, URL, sampling, and linked flag triggers are combined.

any means that if any of the triggers match, the session will be recorded. all means that all the triggers must match for the session to be recorded.

version1 | 2

Config version - defaults to 1 (legacy). When version is 2, triggerGroups is used instead of individual trigger fields.

triggerGroupsSessionRecordingTriggerGroup[]

V2 Trigger Groups - multiple named trigger groups with their own conditions and sample rates. Only used when version === 2.