Skip to main content

Recording

Normalized recording view used across list and detail queries, including derived page names, converted monetary values, watch state, and per-viewer permissions. Returned by recordingsList, recordingsInGroup, visitorsRecordingsDetails, and recording.

type Recording {
  id: Int!
  userId: String!
  sessionId: String!
  visitorId: String
  siteId: Int!
  recordedAt: Int!
  duration: Int!
  visitedPagesCount: Int!
  device: SnapshotDevice
  browser: RecordingBrowser!
  os: RecordingOs!
  country: Country
  tags: [String!]!
  lastEventAt: Int!
  finalValue: SessionValue!
  firstPageUrl: String
  firstPageName: String
  lastPageUrl: String
  lastPageName: String
  maxValue: SessionValue!
  viewedAt: Int
  hashedId: String
  identifier: String
  inProgress: Boolean!
  screenWidth: String
  screenHeight: String
  referrer: Referrer
  permissions: RecordingPermissions!
  version: Int!
  valid: Boolean!
  virtual: Boolean!
  sessionToken: String
}

Fields​

Recording.id ● Int! non-null scalar​

Numeric recording id for tag, watch, delete, and sharedUrl operations; recording instead takes hashedId.

Recording.userId ● String! non-null scalar​

Recording owner account id, serialized as a string.

Recording.sessionId ● String! non-null scalar​

Raw session identifier; differs from both numeric id and public hashedId.

Recording.visitorId ● String scalar​

Recorded visitor id; null when absent. Search it with visitorsRecordings.

Recording.siteId ● Int! non-null scalar​

Site id for scoping recordings queries.

Recording.recordedAt ● Int! non-null scalar​

Recording start time in Unix seconds.

Recording.duration ● Int! non-null scalar​

Session duration in seconds.

Recording.visitedPagesCount ● Int! non-null scalar​

Recording.device ● SnapshotDevice enum​

Device category derived from the recorded device code and version; null when the code cannot be mapped.

Recording.browser ● RecordingBrowser! non-null enum​

Recording.os ● RecordingOs! non-null enum​

Recording.country ● Country object​

Resolved country; null when absent or unrecognized.

Recording.tags ● [String!]! non-null scalar​

Recording.lastEventAt ● Int! non-null scalar​

Last recorded event time in Unix seconds.

Recording.finalValue ● SessionValue! non-null object​

Final session value, with original and display currency amounts scaled by 10,000.

Recording.firstPageUrl ● String scalar​

Recorded first-page URL; null when absent.

Recording.firstPageName ● String scalar​

Normalized first page: homepage or a /path when it is on the recording's site, otherwise the normalized URL. recording always returns the normalized URL; null when absent.

Recording.lastPageUrl ● String scalar​

Recorded last-page URL; null when absent.

Recording.lastPageName ● String scalar​

Normalized last page: homepage or a /path when it is on the recording's site, otherwise the normalized URL. recording always returns the normalized URL; null when absent.

Recording.maxValue ● SessionValue! non-null object​

Maximum session value, with original and display currency amounts scaled by 10,000.

Recording.viewedAt ● Int scalar​

Current viewer's watched time in Unix seconds; null without a watch marker or for shared sessions.

Recording.hashedId ● String scalar​

Public id derived from numeric id; pass to recording.hashedId, not to numeric-id mutations.

Recording.identifier ● String scalar​

Recorded custom visitor identifier; null when absent. Search it with visitorsRecordings.

Recording.inProgress ● Boolean! non-null scalar​

Whether the session may still be recording: it has not ended and its last event is under 30 minutes old (or it has no events), or it ended under 5 minutes ago.

Recording.screenWidth ● String scalar​

Screen width in pixels, serialized as a string; null when absent.

Recording.screenHeight ● String scalar​

Screen height in pixels, serialized as a string; null when absent.

Recording.referrer ● Referrer object​

Stored referrer components; individual components may be null.

Recording.permissions ● RecordingPermissions! non-null object​

Actions available to the current viewer; view and share also depend on the recording storage horizon.

Recording.version ● Int! non-null scalar​

Recording format version.

Recording.valid ● Boolean! non-null scalar​

Whether the recording is marked valid; false when unset.

Recording.virtual ● Boolean! non-null scalar​

Recorded virtual-session flag; false when unset.

Recording.sessionToken ● String scalar​

Generated player session token for this recording, valid for one hour.

Member Of​

InterestingRecording object ● RecordingsInGroupMeta object ● RecordingsListMeta object ● RecordingWithCursor object ● SurveyResponseDetail object ● VisitorsRecordingsMeta object