Snapshot

Heatmap snapshot returned by snapshot, snapshots, snapshotsList and pageCameraSnapshots, with collection settings and derived state.

type Snapshot {
  createdAt: Int
  description: String
  device: String
  id: Int!
  maxVisits: Int
  name: String
  status: String
  snapshotStatus: SnapshotStatus
  totalVisits: Int
  totalClicks: Int
  formatVersion: Int
  sourceUrl: String
  siteId: Int
  stoppedAt: Int
  deletedAt: Int
  manualScreenshot: Boolean
  screenshotStatus: String
  numUnprocessedLogs: Int
  folderId: Int
  expiresAt: Int
  firstEvent: Int
  lastEvent: Int
  userId: Int
  thumbnailUrl: String
  duration: Int
  totalDays: Int
  recordingCount: Int
  endedAt: Int
  expiresAtOption: SnapshotExpiredAtOption
  startsAt: Int
  startsAtOption: SnapshotStartsAtOption
  useSamplingRatio: Boolean
  samplingRatio: Int
  trackingDevices: [SnapshotDevice]
  trackingOption: SnapshotTrackingOption
  matchingRuleParams: String
  removeElementsOption: SnapshotRemoveElementsOption
  removeElements: String
  useWaitAfterLoad: Boolean
  waitAfterLoad: Int
  hasData: Boolean
  isDemo: Boolean
  isExpired: Boolean
  isAbTestVariant: Boolean
  isFlowVariant: Boolean @deprecated
  permissions: SnapshotPermissions!
  reoccurring: Boolean
  createdByUserId: Int
  createdByUserName: String @deprecated
  createdByName: String
  autoExport: SnapshotAutoExport
  autoExportEmails: [String!]
}

Fields

Snapshot.createdAt ● Int scalar

Creation time in Unix seconds; null when unavailable.

Snapshot.description ● String scalar

Saved descriptive text; new snapshots use an empty string, and null means no value is recorded.

Snapshot.device ● String scalar

Screenshot device as desktop, phone or tablet; separate from the devices whose traffic is tracked.

Snapshot.id ● Int! non-null scalar

Snapshot.maxVisits ● Int scalar

Visit limit for collection; null when no limit is recorded.

Snapshot.name ● String scalar

Snapshot.status ● String scalar

Saved lifecycle text: active, stopped or deleted; use snapshotStatus for the derived display state.

Snapshot.snapshotStatus ● SnapshotStatus enum

Derived lifecycle state combining screenshot errors, schedule, limits and saved status.

Snapshot.totalVisits ● Int scalar

Visit count; list queries refresh it when possible and cap it at a positive maxVisits.

Snapshot.totalClicks ● Int scalar

Click count; list queries refresh it when possible.

Snapshot.formatVersion ● Int scalar

Screenshot/report format version; may be null if not recorded.

Snapshot.sourceUrl ● String scalar

Snapshot.siteId ● Int scalar

Site ID usable with site; null when no site is associated.

Snapshot.stoppedAt ● Int scalar

Unix seconds when collection is stopped; null when no stop time is recorded.

Snapshot.deletedAt ● Int scalar

Unix seconds when deletion is recorded; null before deletion.

Snapshot.manualScreenshot ● Boolean scalar

True for page camera snapshots using a user-uploaded screenshot and element data.

Snapshot.screenshotStatus ● String scalar

Capture state: needs_user_files, needs_processing, processing, processed or error; may be null if unset.

Snapshot.numUnprocessedLogs ● Int scalar

Pending log count awaiting processing; null when no count is recorded.

Snapshot.folderId ● Int scalar

Folder ID from folders; null when unfiled.

Snapshot.expiresAt ● Int scalar

Collection expiration in Unix seconds; null when no expiration is recorded.

Snapshot.firstEvent ● Int scalar

First recorded event time in Unix seconds; null when not recorded.

Snapshot.lastEvent ● Int scalar

Last recorded event time in Unix seconds; null when not recorded.

Snapshot.userId ● Int scalar

Owning account ID; may be null if not available in the response.

Snapshot.thumbnailUrl ● String scalar

Signed thumbnail URL valid for about one hour; an empty string until the screenshot is processed or when no URL can be generated. Reading it does not request a new capture.

Snapshot.duration ● Int scalar

Elapsed collection duration in whole days, truncated toward zero, using the computed end or current time.

Snapshot.totalDays ● Int scalar

Configured collection span in whole days, truncated toward zero; null when expiration is absent.

Snapshot.recordingCount ● Int scalar

Always zero in transformed snapshot query responses.

Snapshot.endedAt ● Int scalar

Unix seconds of stop, visit-limit completion or expiration, in that priority order; null when no end is determined.

Snapshot.expiresAtOption ● SnapshotExpiredAtOption enum

DEFAULT only when both the 60-day span and 25000-visit limit match; otherwise CUSTOM.

Snapshot.startsAt ● Int scalar

Scheduled collection start in Unix seconds; null for an immediate start, which uses creation time.

Snapshot.startsAtOption ● SnapshotStartsAtOption enum

SCHEDULED when a start time is stored, even after that time passes; otherwise IMMEDIATELY.

Snapshot.useSamplingRatio ● Boolean scalar

True when a custom samplingRatio is stored.

Snapshot.samplingRatio ● Int scalar

One-in-N visit sampling denominator; null when custom sampling is disabled. New values range from 2 to 50000.

Snapshot.trackingDevices ● [SnapshotDevice] list enum

Devices selected by the matching rule; defaults to all devices when no device restriction is present.

Snapshot.trackingOption ● SnapshotTrackingOption enum

Rule type inferred from stored matching flags; URL is returned only when at least one strict flag is enabled.

Snapshot.matchingRuleParams ● String scalar

JSON-encoded object of the current rule's MatchingRule values with snake_case keys, such as {"wildcard":"example.com/*"} or {"regex":"^https://example[.]com/"}; {} for DEFAULT.

Snapshot.removeElementsOption ● SnapshotRemoveElementsOption enum

Capture cleanup inferred from stored popup or selector options; defaults to DEFAULT.

Snapshot.removeElements ● String scalar

Plain CSS selector text used for capture removal; null when not configured, and newly saved text is capped at 1000 characters.

Snapshot.useWaitAfterLoad ● Boolean scalar

True when a custom capture delay is stored, including a zero-second delay.

Snapshot.waitAfterLoad ● Int scalar

Custom capture delay after page load in seconds, from 0 to 60 for newly saved settings; null when not configured.

Snapshot.hasData ● Boolean scalar

True when saved visits or clicks are greater than zero.

Snapshot.isDemo ● Boolean scalar

Always false in transformed snapshot query responses.

Snapshot.isExpired ● Boolean scalar

True when expiresAt is null or in the past.

Snapshot.isAbTestVariant ● Boolean scalar

True when the snapshot belongs to an A/B test variant.

Snapshot.permissions ● SnapshotPermissions! non-null object

Action availability for this snapshot and current session.

Snapshot.reoccurring ● Boolean scalar

True when automatic creation of a successor is enabled; false when unset.

Snapshot.createdByUserId ● Int scalar

Creating user ID; null when no creator is recorded.

Snapshot.createdByName ● String scalar

Saved creator name; null when no creator name is recorded.

Snapshot.autoExport ● SnapshotAutoExport enum

Auto-export cadence; null when the heatmap does not export itself.

Snapshot.autoExportEmails ● [String!] list scalar

Addresses emailed each auto-export's download link; empty when exports only reach the Exports list.

Show deprecated

Snapshot.isFlowVariant ● Boolean deprecated scalar

DEPRECATED

Use is_ab_test_variant instead

Deprecated alias of isAbTestVariant.

Snapshot.createdByUserName ● String deprecated scalar

DEPRECATED

Use created_by_name instead

Deprecated alias of createdByName; null when no creator name is recorded.

Returned By

pageCameraSnapshots query ● renameSnapshot mutation ● snapshot query

Member Of

SnapshotPaginatedList object ● SnapshotsListMeta object