Skip to main content

CreateSnapshotsSettings

Shared capture and collection settings accepted by createSnapshots.

input CreateSnapshotsSettings {
  maxVisits: Int
  pageCameraSnapshot: Boolean
  preUpload: Boolean
  startsAtOption: StartsAtOption!
  startsAt: Int
  expiresAtOption: ExpiresAtOption!
  expiresAt: Int
  useSamplingRatio: Boolean!
  samplingRatio: Int!
  removeElementsOption: RemoveElementsOption!
  removeElements: String
  useWaitAfterLoad: Boolean!
  waitAfterLoad: Int!
  trackingOption: TrackingOption!
  matchingRule: MatchingRule
  reoccurring: Boolean
  autoExport: SnapshotAutoExport
  autoExportEmails: [String!]
}

Fields​

CreateSnapshotsSettings.maxVisits ● Int scalar​

Visit limit from 1 to the account per-snapshot cap. Used only with expiresAtOption: CUSTOM; omission or DEFAULT uses 25000.

CreateSnapshotsSettings.pageCameraSnapshot ● Boolean scalar​

True uses a user-uploaded screenshot and element data instead of automatic capture; omitted means false.

CreateSnapshotsSettings.preUpload ● Boolean scalar​

With pageCameraSnapshot: true, true starts processing already uploaded files; false or omitted waits for user files. Ignored for automatic capture.

CreateSnapshotsSettings.startsAtOption ● StartsAtOption! non-null enum​

SCHEDULED uses startsAt when supplied; IMMEDIATELY, or a missing startsAt, starts without a scheduled time.

CreateSnapshotsSettings.startsAt ● Int scalar​

Unix seconds for SCHEDULED; ignored for IMMEDIATELY. If supplied, must not be in the past or after expiration; omission leaves the start unscheduled.

CreateSnapshotsSettings.expiresAtOption ● ExpiresAtOption! non-null enum​

DEFAULT uses 60 days and 25000 visits; CUSTOM uses supplied expiresAt and maxVisits, with either missing value falling back to its default.

CreateSnapshotsSettings.expiresAt ● Int scalar​

Unix seconds used only with CUSTOM; must not be in the past or more than three years after start. Omission uses start plus 60 days, with current time as the unscheduled start.

CreateSnapshotsSettings.useSamplingRatio ● Boolean! non-null scalar​

True applies samplingRatio; false ignores its required value and clears custom sampling.

CreateSnapshotsSettings.samplingRatio ● Int! non-null scalar​

Track one in this many visits, integer 2 to 50000 when useSamplingRatio is true. Required by the schema even when false, when the value is ignored.

CreateSnapshotsSettings.removeElementsOption ● RemoveElementsOption! non-null enum​

Screenshot cleanup mode; only REMOVE_ELEMENTS uses removeElements.

CreateSnapshotsSettings.removeElements ● String scalar​

Comma-separated CSS selector text, for example .modal, #banner; truncated to 1000 characters. Used only with REMOVE_ELEMENTS; omitted or empty text adds no removal rule.

CreateSnapshotsSettings.useWaitAfterLoad ● Boolean! non-null scalar​

True applies waitAfterLoad to screenshot capture; false ignores its required value and clears the custom delay.

CreateSnapshotsSettings.waitAfterLoad ● Int! non-null scalar​

Delay after page load in seconds, clamped to 0 through 60. Required by the schema even when useWaitAfterLoad is false, when the value is ignored.

CreateSnapshotsSettings.trackingOption ● TrackingOption! non-null enum​

Selects the matching rule type; DEFAULT ignores matchingRule, while other types use their corresponding fields.

CreateSnapshotsSettings.matchingRule ● MatchingRule input​

Ignored for DEFAULT; URL accepts omitted strict flags as false. WILDCARD, REGEX, NAMED and GOOGLE_OPTIMIZE need their respective text field.

CreateSnapshotsSettings.reoccurring ● Boolean scalar​

True requests a successor snapshot when this one reaches its date or visit limit, subject to account eligibility; defaults to false.

CreateSnapshotsSettings.autoExport ● SnapshotAutoExport enum​

Auto-export cadence; omission or null creates heatmaps that do not export themselves. A cadence requires the autoExport snapshots permission, and AI-origin requests cannot set one.

CreateSnapshotsSettings.autoExportEmails ● [String!] list scalar​

Up to 10 addresses that receive each auto-export's download link; addresses differing only in case are sent once. Omission or an empty list sends no email, and exports still reach the Exports list. AI-origin requests must omit it, even as an empty list.

Member Of​

createSnapshots mutation