Recordings

Get a recording

One recording with everything kept about it and its epochs. Needs analytics.sessions.read.

get/v1/recordings/{recordingId}

Request

  • Base URL: https://api.ironfang.com/analytics
  • URL: https://api.ironfang.com/analytics/v1/recordings/{recordingId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Response

The recording

browserstring nullable required

Coarse class from the user agent.

bytesinteger required

Compressed bytes stored.

chunksinteger required
countrystring nullable required

From Cloudflare, when the request came through it.

created_atstring date-time required
device'desktop' | 'mobile' | 'tablet' | 'null' nullable required
duration_msinteger required

The recorded activity, in milliseconds: in each page load, from its first batch's start to its last batch's end by the browser's monotonic clock, summed.

end_reason'finished' | 'idle_timeout' | 'duration_cap' | 'byte_cap' | 'site_disabled' | 'null' nullable required
ended_atstring date-time nullable required
entry_pathstring nullable required
eventsinteger required
expires_atstring date-time required
first_received_atstring date-time nullable required
idstring uuid required
ipstring nullable required

The visitor's IP address.

last_received_atstring date-time nullable required
last_seen_atstring date-time required

The last batch or heartbeat. An open page sends a heartbeat every 30 seconds.

liveboolean required

Still open and heard from in the last 90 seconds: someone is on the page. Open but quiet means the visitor has most likely gone; the recording closes after 30 minutes without a word, because leaving a page cannot be told apart from moving to the next one.

originstring required
osstring nullable required
playableboolean required

True once some epoch holds a checkpoint at its start.

session_idstring uuid nullable required

The session the recording belongs to. Null only for a recording made before sessions that has not been placed in one yet.

site_idstring uuid required
site_namestring required
state'pending' | 'recording' | 'ready' | 'partial' | 'unplayable' required
visitor_idstring uuid nullable required

The browser that made the recording: a random id the recorder (SDK 0.3.0 and later) keeps in the site's localStorage. The same id on two recordings is the same browser, unless its storage was cleared in between. Null for recordings from older recorders.

config_versioninteger required

The site configuration the recording was made under.

ip_source'cloudflare' | 'edge' | 'peer' | 'null' nullable required

cloudflare is the visitor's address as Cloudflare reported it; edge and peer are whoever connected, which is the visitor only when nothing sat in between.

languagestring nullable required
pixel_rationumber nullable required
referrerstring nullable required

Origin and path only; the query and fragment are never kept.

rrweb_versionstring nullable required
sdk_versionstring nullable required
timezonestring nullable required

IANA time zone the browser reported.

user_agentstring nullable required

The full User-Agent header, at most 512 characters.

Changes

No recorded changes to this operation across all 1 revision of this API.