Skip to main content

SnapshotPermissions

Per-snapshot action availability returned with snapshot queries, accounting for session rights and snapshot state.

type SnapshotPermissions {
  canSetReoccurring: Boolean!
  canUnsetReoccurring: Boolean!
  canView: Boolean!
  canEdit: Boolean!
  canEditStartDate: Boolean!
  canEditExpiration: Boolean!
  canDuplicate: Boolean!
  canRefresh: Boolean!
  canResume: Boolean!
  canExport: Boolean!
  canPause: Boolean!
}

Fields​

SnapshotPermissions.canSetReoccurring ● Boolean! non-null scalar​

Whether recurrence can be turned on: needs edit rights and an automatic snapshot that is not an A/B test variant and is not completed or stopped.

SnapshotPermissions.canUnsetReoccurring ● Boolean! non-null scalar​

Whether recurrence can be disabled before completion or creation of a successor.

SnapshotPermissions.canView ● Boolean! non-null scalar​

Whether the snapshot has visits or clicks available to view.

SnapshotPermissions.canEdit ● Boolean! non-null scalar​

Whether the session can edit this snapshot; A/B test variants are excluded.

SnapshotPermissions.canEditStartDate ● Boolean! non-null scalar​

Whether a future start can be changed; recurring snapshots and those with successors are excluded.

SnapshotPermissions.canEditExpiration ● Boolean! non-null scalar​

Whether expiresAt and maxVisits can be changed: needs edit rights, under three years of running time, visits below the account cap and no recurring successor.

SnapshotPermissions.canDuplicate ● Boolean! non-null scalar​

Whether copying is available; manual captures, A/B test variants, recurring snapshots and those with successors are excluded.

SnapshotPermissions.canRefresh ● Boolean! non-null scalar​

Whether automatic recapture is available for a non-manual snapshot in running or error state.

SnapshotPermissions.canResume ● Boolean! non-null scalar​

Whether a stopped, unexpired snapshot has visits remaining and no variant or successor restriction.

SnapshotPermissions.canExport ● Boolean! non-null scalar​

Whether the snapshot has data and no screenshot error; export capability requirements still apply.

SnapshotPermissions.canPause ● Boolean! non-null scalar​

Whether the current session can pause a started active snapshot without variant or successor restrictions.

Member Of​

Snapshot object