RecordingSettings

Recording configuration exposed in both the current sampling fields and deprecated legacy sampling fields for backward-compatible clients. Returned within site and sites and by setRecordingSettings.

type RecordingSettings {
  id: Int
  pageTargetingEnabled: Boolean
  endSessionOnBlockedUrl: Boolean
  urlMatchingRules: String
  blockedUrlMatchingRules: String
  maskElements: String
  samplingType: SamplingType
  samplingValue: Float
  samplingStrategy: String @deprecated
  samplingNumRecordings: Int @deprecated
  samplingStartDate: Int @deprecated
  samplingEndDate: Int @deprecated
  samplingUpdatedAt: Int @deprecated
}

Fields

RecordingSettings.id ● Int scalar

RecordingSettings.pageTargetingEnabled ● Boolean scalar

Whether inclusion-page rules apply; normalized to false when unset.

RecordingSettings.endSessionOnBlockedUrl ● Boolean scalar

True ends a session at a blocked page; false skips the page without ending the session.

RecordingSettings.urlMatchingRules ● String scalar

JSON-encoded object with a rules array; URL rules are normalized and deduplicated by URL.

RecordingSettings.blockedUrlMatchingRules ● String scalar

JSON-encoded object with a rules array for ignored pages; normalized and deduplicated by URL.

RecordingSettings.maskElements ● String scalar

JSON-encoded array of objects with selector and optional note.

RecordingSettings.samplingType ● SamplingType enum

Automatic, percentage, or fixed-count sampling mode; null when unset.

RecordingSettings.samplingValue ● Float scalar

Percent of visitors (0-100, two decimals) for RATE, target recordings per month for STATIC; null when unset.

Show deprecated

RecordingSettings.samplingStrategy ● String deprecated scalar

DEPRECATED

use samplingType and samplingValue

Legacy sampling mode; null when unset.

RecordingSettings.samplingNumRecordings ● Int deprecated scalar

DEPRECATED

use samplingType and samplingValue

Legacy target recording count; null when unset.

RecordingSettings.samplingStartDate ● Int deprecated scalar

DEPRECATED

use samplingType and samplingValue

Legacy sampling start date in Unix seconds; null when unset.

RecordingSettings.samplingEndDate ● Int deprecated scalar

DEPRECATED

use samplingType and samplingValue

Legacy sampling end date in Unix seconds; null when unset.

RecordingSettings.samplingUpdatedAt ● Int deprecated scalar

DEPRECATED

use samplingType and samplingValue

Legacy sampling update time in Unix seconds; null when unset.

Returned By

setRecordingSettings mutation

Member Of

Site object