Session

Objects

Session

id
string
Unique identifier for the session
website_id
string
ID of the website where the session was recorded
session_url
string
URL to view the session in LiveSession dashboard
creation_timestamp
integer
Unix timestamp when the session was created
duration
integer
Total duration of the session in seconds
end_timestamp
integer
Unix timestamp when the session ended
active_time
integer
Total time the user was actively interacting with the page in seconds
end_url
string
The last URL visited during the session
expiration_timestamp
integer
Unix timestamp when the session recording will expire
last_event_timestamp
integer
Unix timestamp of the last event recorded in the session
product
string
Product identifier associated with the session
device
string
Device type (e.g., desktop, mobile, tablet)
tags
array of string
Custom tags associated with the session
last_seen_page_view_id
string
ID of the last page view in the session
seen
boolean
Whether the session has been viewed in the dashboard
referrer
string
URL where the user came from before starting the session
start_url
string
First URL visited during the session
visitor_first_session
boolean
Whether this is the visitor's first session
engagment_score
number
Calculated engagement score for the session (0-100)
visitor
object
- id
  string
  Unique identifier for the visitor
- ip
  string
  IP address of the visitor
- geolocation
  object
  country_code
  string
  Two-letter country code (ISO 3166-1 alpha-2)
  city
  string
  City name
  region
  string
  Region or state name
- name
  string
  Name of the visitor if identified
- email
  string
  Email address of the visitor if identified
- email_hash
  string
  Hashed version of the visitor's email for privacy
- params
  array of object
  Custom parameters associated with the visitor
  name
  string
  Parameter name
  value
  string
  Parameter value
- last_session_timestamp
  integer
  Unix timestamp of the visitor's last session
- first_session_timestamp
  integer
  Unix timestamp of the visitor's first session
resolution
object
- height
  integer
  Screen height in pixels
- width
  integer
  Screen width in pixels
- resolution
  string
  Screen resolution (e.g., "1920x1080")
os
object
- name
  string
  Operating system name (e.g., Windows, macOS, iOS)
- version
  string
  Operating system version
browser
object
- description
  string
  Full browser description string
- name
  string
  Browser name (e.g., Chrome, Firefox, Safari)
- version
  string
  Browser version
utm
object
- source
  string
  UTM source parameter (e.g., google, facebook)
- medium
  string
  UTM medium parameter (e.g., cpc, social)
- campaign
  string
  UTM campaign parameter
- term
  string
  UTM term parameter (search keywords)
- content
  string
  UTM content parameter
page_views_statistics
object
- count
  integer
  Total number of page views in the session
events_statistics
object
- clicks
  integer
  Total number of clicks during the session
- error_clicks
  integer
  Number of clicks on error elements
- rage_clicks
  integer
  Number of rapid clicks indicating user frustration
- error_logs
  integer
  Number of JavaScript errors logged
- net_errors
  integer
  Number of network errors encountered

Example

{
  "id": "",
  "website_id": "",
  "session_url": "",
  "creation_timestamp": 0,
  "duration": 0,
  "end_timestamp": 0,
  "active_time": 0,
  "end_url": "",
  "expiration_timestamp": 0,
  "last_event_timestamp": 0,
  "product": "",
  "device": "",
  "tags": [],
  "last_seen_page_view_id": "",
  "seen": false,
  "referrer": "",
  "start_url": "",
  "visitor_first_session": false,
  "engagment_score": 0,
  "visitor": {
    "id": "",
    "ip": "",
    "geolocation": {
      "country_code": "",
      "city": "",
      "region": ""
    },
    "name": "",
    "email": "",
    "email_hash": "",
    "params": [
      {
        "name": "",
        "value": ""
      }
    ],
    "last_session_timestamp": 0,
    "first_session_timestamp": 0,
    "__UNSAFE_refPath": null
  },
  "resolution": {
    "height": 0,
    "width": 0,
    "resolution": ""
  },
  "os": {
    "name": "",
    "version": ""
  },
  "browser": {
    "description": "",
    "name": "",
    "version": ""
  },
  "utm": {
    "source": "",
    "medium": "",
    "campaign": "",
    "term": "",
    "content": ""
  },
  "page_views_statistics": {
    "count": 0
  },
  "events_statistics": {
    "clicks": 0,
    "error_clicks": 0,
    "rage_clicks": 0,
    "error_logs": 0,
    "net_errors": 0
  },
  "__UNSAFE_refPath": null
}

ErrorResponse SessionVisitorData

Built with

Show your support! Star us on GitHub ⭐️

Star