Skip to main content

SnapshotStatus

Derived lifecycle states returned by snapshot queries; the first applicable state takes precedence in enum order.

enum SnapshotStatus {
  ERROR
  SCHEDULED
  COMPLETED
  RUNNING
  DELETED
  UNKNOWN
}

Values​

SnapshotStatus.ERROR​

Screenshot capture failed; takes precedence over every other state.

SnapshotStatus.SCHEDULED​

Active with a start time still in the future.

SnapshotStatus.COMPLETED​

Paused, expired or at its visit limit; collection has finished.

SnapshotStatus.RUNNING​

Active and collecting visits.

SnapshotStatus.DELETED​

Deleted snapshot that matches none of the states above.

SnapshotStatus.UNKNOWN​

None of the other states applies.

Member Of​

Snapshot object ● SnapshotStats object