Skip to main content
GET
Overview of the sessions of an organisation

Authorizations

Authorization
string
header
required

Enter your personal access token (PAT) to authenticate

Path Parameters

workspaceUuid
string<uuid>
required

The UUID of the workspace

Example:

"123e4567-e89b-12d3-a456-426614174000"

organisationUuid
string<uuid>
required

The UUID of the organisation

Example:

"123e4567-e89b-12d3-a456-426614174000"

Query Parameters

page
integer

The page number for pagination

Example:

1

size
integer

The number of sessions per page (1-1000)

Required range: 1 <= x <= 1000
Example:

10

date
string<date>

The specific date to filter sessions.

Example:

"2025-03-01"

date_from
string<date>

The start date for filtering sessions. Can only be used if date is not provided.

Example:

"2025-03-01"

date_to
string<date>

The end date for filtering sessions. Can only be used if date is not provided.

Example:

"2025-03-10"

url
string

Filters sessions where the visited URL contains the given string.

Example:

"checkout"

referrer
string

Filters sessions where the referrer contains the given string.

Example:

"google.com"

Response

200 - application/json

List of sessions

current_page
integer
Example:

1

last_page
integer
Example:

10

per_page
integer
Example:

15

total
integer
Example:

150

next_page_url
string | null
Example:

"https://api.example.com/v1/workspaces?page=2"

prev_page_url
string | null
Example:

null

first_page_url
string | null
Example:

"https://api.example.com/v1/workspaces?page=1"

last_page_url
string | null
Example:

"https://api.example.com/v1/workspaces?page=10"

path
string | null
Example:

"https://api.example.com/v1/workspaces"

from
integer | null
Example:

1

to
integer | null
Example:

15

data
Session · object[]
success
boolean
Example:

true