Skip to main content

Retrieve Website Sessions - API

This API endpoint allows FullSession users to retrieve website visitor session data for a specific customer and site.

Updated this week


Endpoint

GET https://app.fullsession.io/v1/external/sessions/{customerId}/{siteId}?startAfter={timestamp}

Example

GET https://app.fullsession.io/v1/external/sessions/cus_jjeOsw/mdoedw4q2?startAfter=175309156756

You can get the customerId from the settings page under FullSession Setup, and the siteId from the domain listing page (or after generating the API token)


Description

This endpoint retrieves a paginated list of website visitor sessions for a specific customer and site.


Authentication

This endpoint requires OAuth2 authentication.

You can generate a new API token by visiting the “API Tokens” tab under the Settings page in FullSession.

Include the token in the Authorization header as follows:


Path Parameters

Parameter

Type

Description

customerId

string

Unique customer ID (e.g. cus_jjeiw4Osw)

siteId

string

Unique site ID (e.g. mdo92edw4q2)


Query Parameters

Parameter

Type

Required

Description

startAfter

integer

Yes

Timestamp (in ms) indicating the pagination point. Use the startAfter value returned in the previous response to fetch the next page. If not present in the response, there are no more sessions to load.


Successful Response (HTTP 201)

{ "status": 201, "message": "success", "data": { "startAfter": 1753091569756, "sessions": [ { "country": "Germany", "os": "Windows", "city": "Heidelberg", "landingPage": "/en", "activeTime": 52212, "uuid": "df3d651-1ca3-53d7d-9384-2348d31eba52f", "userId": "xpn4rob75vs", "browserFullVersion": "138.0.0.0", "duration": 246941, "referrer": "Direct", "countryCode": "GE", "browser": "Chrome", "startTime": 1753091998714, "exitPage": "/en/auth/logout", "endTime": 1753092245655, "device": "desktop", "pages": [ { "fullPath": "https://fullsession.io" }, ... ] }, ... ] } }

Notes

  • The startAfter field in the response should be used as the next value for the startAfter query parameter to paginate results.

  • If startAfter is not returned, it indicates that there are no more sessions to load.


Session Object Fields

Field

Type

Description

uuid

string

Unique session identifier

userId

string

Unique user identifier

country

string

Country name of the visitor

countryCode

string

2-letter country code

city

string

Visitor’s city

os

string

Operating system of the device

browser

string

Browser name

browserFullVersion

string

Full browser version

device

string

Device type (desktop, mobile, etc.)

referrer

string

Traffic source (e.g., Direct, Google)

landingPage

string

Initial page visited

exitPage

string

Last page before session end

startTime

integer

Session start timestamp (ms)

endTime

integer

Session end timestamp (ms)

duration

integer

Total session duration (ms)

activeTime

integer

Time spent actively interacting (ms)

pages

array

List of visited pages (in order)


Pagination Strategy

  1. Make the first request with an initial startAfter value (e.g., the timestamp of the earliest session).

  2. Use the startAfter value returned in the response for the next request.

  3. Repeat until startAfter is no longer included in the response.

Did this answer your question?