Skip to main content
GET
/
v1
/
workspaces
/
{workspaceUuid}
/
sessions
Overview of the sessions in a date range
curl --request GET \
  --url https://api.snitcher.com/v1/workspaces/{workspaceUuid}/sessions \
  --header 'Authorization: Bearer <token>'
{
  "current_page": 1,
  "last_page": 10,
  "per_page": 15,
  "total": 150,
  "next_page_url": "https://api.example.com/v1/workspaces?page=2",
  "prev_page_url": null,
  "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",
          "time_on_page": 0,
          "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",
          "fields": [
            {
              "name": "<string>",
              "value": "<string>"
            }
          ],
          "name": "plan_selected",
          "properties": [
            {
              "name": "<string>",
              "value": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "success": true,
  "truncated": false,
  "total_organisations": 42,
  "organisation_limit": 10000
}

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"

Query Parameters

​
segmentUuid
string<uuid>

Only include sessions matching this segment UUID

Example:

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

​
date
string<date>

The specific date to filter sessions. Cannot be used together with date_from/date_to.

Example:

"2025-03-01"

​
date_from
string<date>

Start date for filtering sessions (inclusive).

Example:

"2025-03-01"

​
date_to
string<date>

End date for filtering sessions (inclusive).

Example:

"2025-03-10"

​
url
string

Filter sessions where the visited URL contains the given string.

Example:

"checkout"

​
referrer
string

Filter sessions where the referrer contains the given string.

Example:

"google.com"

​
page
integer

The page number for pagination.

Example:

1

​
size
integer

Number of sessions per page (1-1000).

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

10

Response

List of sessions. When more than organisation_limit organisations match the date range, the response is truncated to the most-recently-active organisations and truncated is set to true. The caller can use the per-organisation sessions endpoint to backfill any orgs beyond the cap.

​
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

​
truncated
boolean

True when the organisation set was capped to organisation_limit.

Example:

false

​
total_organisations
integer

Total number of organisations matching the filter, before any cap.

Example:

42

​
organisation_limit
integer

Maximum number of organisations included in a single response.

Example:

10000