Sessions

List visitor sessions

GET/api/websites/{websiteId}/sessions

Returns a page of visitor sessions in the date range, newest first. Search matches distinct ID, city, browser, operating system, or device.

Headers

Name	Type	Description
Authorizationrequired	string	Authentication credentials, e.g. `Bearer <token>`.

Path parameters

Name	Type	Description
websiteIdrequired	string	Website ID.

Query parameters

Name	Type	Description
startAt	number	Start of the date range as a Unix timestamp in milliseconds.
endAt	number	End of the date range as a Unix timestamp in milliseconds.
startDate	string	Start of the date range as an ISO 8601 date or date-time.
endDate	string	End of the date range as an ISO 8601 date or date-time.
timezone	string	IANA time zone used to interpret dates and group results, for example America/New_York.
unit	string	Time interval used to group results: minute, hour, day, month, or year.
compare	enum<string>	Comparison period: prev for the previous period or yoy for the same period last year. Options: `prev`, `yoy`
path	string	Filter by page URL path.
referrer	string	Filter by referring URL.
title	string	Filter by page title.
query	string	Filter by page URL query string.
os	string	Operating system used by the visitor.
browser	string	Browser used by the visitor.
device	string	Device category used by the visitor.
country	string	Country code of the visitor.
region	string	Region or subdivision of the visitor.
city	string	City of the visitor.
tag	string	Tag attached to the tracked activity.
hostname	string	Hostname on which the activity occurred.
distinctId	string	Custom identifier assigned to the visitor.
language	string	Preferred language reported by the visitor browser.
event	string	Filter by custom event name.
utmSource	string	UTM campaign source.
utmMedium	string	UTM campaign medium.
utmCampaign	string	UTM campaign name.
utmContent	string	UTM campaign content.
utmTerm	string	UTM campaign search term.
segment	string	ID of a saved segment used to filter results.
cohort	string	ID of a saved cohort used to filter visitors.
eventType	integer	Event type: 1 for a pageview or 2 for a custom event.
excludeBounce	string	Set a non-empty value to exclude visits with only one pageview.
match	enum<string>	Whether records must match all filters or any filter. Options: `all`, `any`
page	integer	Page number, starting at 1.
pageSize	integer	Number of results per page.
maxResults	integer	Maximum number of results to include.
search	string	Search text used to filter results.

Responses

200A page of sessions.

Name	Type	Description
countrequired	integer	Number of matching records.
datarequired	WebsiteSession[]	Data returned by the operation.

isCapped	boolean	Whether the results were truncated by the maximum result limit.
pagerequired	integer	Page number, starting at 1.
pageSizerequired	integer	Number of results per page.

200 example

{
  "count": 0,
  "data": [
    {
      "browser": "string",
      "city": "string",
      "country": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "device": "string",
      "distinctId": "string",
      "events": 0,
      "firstAt": "2024-01-15T09:30:00Z",
      "hostname": "string",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "language": "string",
      "lastAt": "2024-01-15T09:30:00Z",
      "os": "string",
      "region": "string",
      "screen": "string",
      "views": 0,
      "visits": 0,
      "websiteId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "isCapped": true,
  "page": 0,
  "pageSize": 0
}

400Bad request.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

400 example

{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

Code samples

cURL

curl -X GET 'https://api.example.com/api/websites/{websiteId}/sessions' \
  -H 'Authorization: Bearer <token>'

PreviousSave or unsave a session replay NextGet a visitor session