v1

latestOpenAPI 3.0.02026-07-26392662.9 KB

Sessions

Overview of the sessions of an organisation

get/v1/workspaces/{workspaceUuid}/organisations/{organisationUuid}/sessions

Path parameters

workspaceUuidstring uuid required

Example:123e4567-e89b-12d3-a456-426614174000

The UUID of the workspace

organisationUuidstring uuid required

Example:123e4567-e89b-12d3-a456-426614174000

The UUID of the organisation

Query parameters

pageinteger

Example:1

The page number for pagination

sizeinteger

Example:10

The number of sessions per page (1-1000)

datestring date

Example:2025-03-01

The specific date to filter sessions.

date_fromstring date

Example:2025-03-01

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

date_tostring date

Example:2025-03-10

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

urlstring

Example:checkout

Filters sessions where the visited URL contains the given string.

referrerstring

Example:google.com

Filters sessions where the referrer contains the given string.

Response

List of sessions

current_pageinteger

last_pageinteger

per_pageinteger

totalinteger

next_page_urlstring nullable

prev_page_urlstring nullable

first_page_urlstring nullable

last_page_urlstring nullable

pathstring nullable

frominteger nullable

tointeger nullable

successboolean

Example response

{
  "current_page": 1,
  "last_page": 10,
  "per_page": 15,
  "total": 150,
  "next_page_url": "https://api.example.com/v1/workspaces?page=2",
  "first_page_url": "https://api.example.com/v1/workspaces?page=1",
  "last_page_url": "https://api.example.com/v1/workspaces?page=10",
  "path": "https://api.example.com/v1/workspaces",
  "from": 1,
  "to": 15,
  "data": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "organisation_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "started_at": "2021-01-01T00:00:00Z",
      "ended_at": "2021-01-01T00:00:00Z",
      "location": {
        "country": "US",
        "state": "California",
        "city": "Los Angeles",
        "latitude": 34.0522,
        "longitude": -118.2437
      },
      "browser": "Chrome",
      "referrer": "https://google.com",
      "device_type": "mobile",
      "views": [
        {
          "visited_at": "2021-01-01T00:00:00Z",
          "url": "https://acme.com/page?foo=bar#baz"
        }
      ],
      "events": [
        {
          "event_type": "pageview",
          "url": "https://acme.com/pricing",
          "triggered_at": "2021-01-01T00:00:00Z",
          "time_on_page": 45,
          "form_id": "contact-form",
          "form_name": "Contact Form",
          "name": "plan_selected"
        }
      ]
    }
  ],
  "success": true
}