GET
/
api
/
v1
/
workspaces
/
{workspaceUuid}
/
organisations
/
{organisationUuid}
/
sessions
{
  "current_page": 1,
  "last_page": 10,
  "per_page": 15,
  "total": 150,
  "next_page_url": "https://api.example.com/api/v1/workspaces?page=2",
  "prev_page_url": null,
  "first_page_url": "https://api.example.com/api/v1/workspaces?page=1",
  "last_page_url": "https://api.example.com/api/v1/workspaces?page=10",
  "path": "https://api.example.com/api/v1/workspaces",
  "from": 1,
  "to": 15,
  "data": [
    {
      "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
      },
      "views": [
        {
          "visited_at": "2021-01-01T00:00:00Z",
          "time_on_page": 0,
          "url": "https://acme.com/page?foo=bar#baz"
        }
      ]
    }
  ],
  "success": true
}

Authorizations

​
Authorization
string
header
required

Enter your personal access token (PAT) to authenticate

Path Parameters

​
workspaceUuid
string
required

The UUID of the workspace

​
organisationUuid
string
required

The UUID of the organisation

Query Parameters

​
page
integer

The page number for pagination

​
size
integer

The number of sessions per page

Response

200 - application/json
List of sessions
​
current_page
integer
​
last_page
integer
​
per_page
integer
​
total
integer
​
next_page_url
string | null
​
prev_page_url
string | null
​
first_page_url
string | null
​
last_page_url
string | null
​
path
string | null
​
from
integer | null
​
to
integer | null
​
data
object[]

A representation of a session

​
success
boolean
Remove a tag from an organisationGet the user's workspaces