Getting started
WelcomeAPI Changelog
REST API (BETA)
IntroductionReferenceList sessions
Webhooks

Reference

List sessions

Return a list of website sessions.

URL

GET /v1/sessions

Requirements

TypeDescription
scopesusers.sessions:read
tokensPersonal Access Token

Example request

curl -X GET \
https://api.livesession.io/v1/sessions?email=john@example.com \
-H 'content-type: application/json' \
-H 'Authorization: Bearer {YOUR_PERSONAL_ACCESS_TOKEN}'

Parameters

NameSourceDescriptions
emailqueryOptional. The email address that you have associated with a session via identify.
visitor_idqueryOptional. The visitor ID.
pagequeryOptional. The number of page to start with (default 0).
sizequeryOptional. The max number of sessions to return (defaults to 25).

Status codes

CodeStatusDescription
200OKJSON body

Example response

{
"total": 6,
"page": {
"num": 0,
"size": 10
},
"sessions": [
{
"id": "9a000f77-8b3e-41a5-6443-b92ac1ec2538",
"website_id": "f12e633c",
"session_url": "https://app.livesession.io/app/sessions/e836228e-e633-4ba3-6859-dcc57fc370bb/9a000f77-8b3e-41a5-6443-b92ac1ec2538",
"creation_timestamp": 1621514771785,
"duration": 978750,
"end_timestamp": 1621515750535,
"active_time": 9473,
"end_url": "https://livesession.io",
"expiration_timestamp": 1621517550535,
"last_event_timestamp": 1621515750535,
"product": "",
"device": "Desktop",
"tags": null,
"seen": true,
"referrer": "",
"start_url": "https://livesession.io",
"visitor_first_session": true,
"engagment_score": 0.686962962962963,
"visitor": {
"id": "e836228e-e633-4ba3-6859-dcc57fc370bb",
"ip": "",
"geolocation": {
"country_code": "",
"city": "",
"region": ""
},
"last_session_timestamp": 1621514771785,
"first_session_timestamp": 1621514771785,
"sessions_statistics": {
"count": 1
},
"is_favourite": false
},
"resolution": {
"height": 1080,
"width": 3840,
"resolution": ""
},
"os": {
"name": "Linux",
"version": ""
},
"browser": {
"description": "Chrome 90.0.4430.212 on Linux 64-bit",
"name": "Chrome",
"version": "90.0.4430.212"
},
"utm": {
"source": "",
"medium": "",
"campaign": "",
"term": "",
"content": ""
},
"page_views_statistics": {
"count": 1
},
"events_statistics": {
"clicks": 3,
"error_clicks": 0,
"rage_clicks": 0,
"error_logs": 0
}
}
]
}