Skip to content

Recording

A Recording is the replay of one Visit or one agent browser session, masked at capture.

Properties

PropertyTypeRequiredDescription
visitVisitThe Visit it replays, for a person’s session.
actionActionThe agent Action whose browser session it replays.
fileFileThe rendered video File, when one is rendered.
secondsintegerIts length in seconds.

Object

JSON
{
  "$id": "https://api.sb/routewise.dev/recordings/recording_1",
  "$type": "Recording",
  "visit": "visit_1",
  "action": "action_1",
  "file": "file_1",
  "seconds": 1
}

Relationships

  • A Recording replays one Visit: a Recording replays one Visit, linked from every funnel step that Visit reached. replays, inverse recording.

Verbs

  1. getReturns one Recording by id.
    GET /{namespace}/recordings/{id}readNo Event
  2. listReturns Recordings, newest first, one page at a time.
    GET /{namespace}/recordingsreadNo Event

A Recording is kept forever and never edited: it has no update or delete.

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operationowneradminmemberviewer
Recording.getYesYesYesYes
Recording.listYesYesYesYes

Call it

Text
Show me the latest recording.

Example

A buyer abandons checkout on a travel-insurance Site. Her Recording replays the 94-second Visit with card fields masked, and it shows her stuck on the date picker.