Sessions

Get a session

One session with what its browser reported, its journey (every page in the order the visitor saw them, with how long they stayed) and its recordings, each page placed in the recording that saw it. Needs analytics.sessions.read.

get/v1/sessions/{sessionId}

Request

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

Response

The session

anonymisedboolean required

Its IP address, user agent, visitor id, error messages and event properties were cleared at the recording retention.

browserstring nullable required
countrystring nullable required
device'desktop' | 'mobile' | 'tablet' | 'null' nullable required
duration_msinteger required

From the start to the last activity.

end_reason'idle_timeout' | 'duration_cap' | 'null' nullable required

idle_timeout, 30 minutes without the visitor doing anything; duration_cap, 12 hours from its start.

ended_atstring date-time nullable required
entry_pathstring nullable required
exit_pathstring nullable required
expires_atstring date-time required
idstring uuid required
ipstring nullable required

Null once the session is anonymised.

last_activity_atstring date-time required

The visitor's last activity in any tab.

liveboolean required

Active and heard from in the last 90 seconds.

originstring required
osstring nullable required
referrerstring nullable required

Origin and path only.

site_idstring uuid required
site_namestring required
source'sdk' | 'recording' required

sdk, reported page by page by the SDK (0.6.0 and later); recording, known only from its recordings (older SDKs, and visits recorded before sessions), so only recorded pages are in it.

started_atstring date-time required
state'active' | 'ended' required
visitor_idstring uuid nullable required

Null once the session is anonymised.

clock_offset_msinteger required

The server's clock minus the browser's, measured when the session started; journey and timeline times include it.

ip_source'cloudflare' | 'edge' | 'peer' | 'null' nullable required
languagestring nullable required
pixel_rationumber nullable required
sdk_versionstring nullable required
timezonestring nullable required
user_agentstring nullable required

Changes

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