Skip to main content

UpdateSnapshotParams

Settings accepted by updateSnapshot; omitted name falls back to the source URL and omitted recurrence becomes false.

input UpdateSnapshotParams {
  name: String
  startsAtOption: StartsAtOptionUpdate
  startsAt: Int
  expiresAtOption: ExpiresAtOption
  expiresAt: Int
  maxVisits: Int
  useSamplingRatio: Boolean!
  samplingRatio: Int!
  removeElementsOption: RemoveElementsOption!
  removeElements: String
  useWaitAfterLoad: Boolean!
  waitAfterLoad: Int!
  trackingOption: TrackingOption!
  trackingDevices: [SnapshotDevice]
  matchingRule: MatchingRule
  reoccurring: Boolean
  autoExport: SnapshotAutoExport
  autoExportEmails: [String!]
}

Fields​

UpdateSnapshotParams.name ● String scalar​

Replacement name; omission resets it to the source URL. Trimmed, stripped of angle brackets and truncated to 140 characters.

UpdateSnapshotParams.startsAtOption ● StartsAtOptionUpdate enum​

SCHEDULED applies a supplied startsAt only when permissions.canEditStartDate is true; omission leaves the start unchanged.

UpdateSnapshotParams.startsAt ● Int scalar​

Unix seconds used only with SCHEDULED and start-date edit permission; omission leaves it unchanged. Must not be in the past or after expiration.

UpdateSnapshotParams.expiresAtOption ● ExpiresAtOption enum​

Requires permissions.canEditExpiration to take effect. DEFAULT resets date and visit limits; CUSTOM requires both values; omission preserves limits unless rescheduling a default expiration.

UpdateSnapshotParams.expiresAt ● Int scalar​

Unix seconds required with CUSTOM and expiration edit permission; ignored otherwise. Must not be in the past or more than three years after scheduled start or creation.

UpdateSnapshotParams.maxVisits ● Int scalar​

Required with CUSTOM and expiration edit permission: 1 to the account per-snapshot cap. DEFAULT resets to 25000; otherwise ignored.

UpdateSnapshotParams.useSamplingRatio ● Boolean! non-null scalar​

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

UpdateSnapshotParams.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.

UpdateSnapshotParams.removeElementsOption ● RemoveElementsOption! non-null enum​

Screenshot cleanup mode; only REMOVE_ELEMENTS uses removeElements.

UpdateSnapshotParams.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.

UpdateSnapshotParams.useWaitAfterLoad ● Boolean! non-null scalar​

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

UpdateSnapshotParams.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.

UpdateSnapshotParams.trackingOption ● TrackingOption! non-null enum​

DEFAULT rebuilds the rule; other modes rebuild only with non-empty matchingRule, otherwise the current rule and devices are preserved.

UpdateSnapshotParams.trackingDevices ● [SnapshotDevice] list enum​

Devices to track when the matching rule is rebuilt; must be non-empty and include the screenshot device. Ignored when the rule is preserved.

UpdateSnapshotParams.matchingRule ● MatchingRule input​

For non-default tracking, a non-empty object triggers rebuilding; omission or an empty object preserves the rule. Only fields for the selected type are used.

UpdateSnapshotParams.reoccurring ● Boolean scalar​

True enables eligible automatic recurrence; omission sets false. Check permissions.canSetReoccurring or canUnsetReoccurring before changing it.

UpdateSnapshotParams.autoExport ● SnapshotAutoExport enum​

Omission keeps the stored cadence; null turns auto-export off. A new cadence, start, expiration or visit limit restarts the schedule. Changing the cadence or addresses of a heatmap that auto-exports requires the autoExport snapshots permission, and AI-origin requests can only turn it off.

UpdateSnapshotParams.autoExportEmails ● [String!] list scalar​

Replacement list of up to 10 addresses; omission keeps the stored addresses. AI-origin requests must omit it, including when they turn auto-export off.

Member Of​

updateSnapshot mutation