Cloady Docs
API ReferenceEndpointsApplications

List browser sessions

Returns active sessions, sessions in the range, mean duration and how many had a JavaScript error or a rage or dead click, session counts per lens, and the 100 most recently active sessions in the chosen lens. A route filter keeps sessions that viewed that page at any point. Filter fields: `route` (the page template), `device`, `browser`, `os` and `country`.

GET
/api/workspaces/{workspaceSlug}/apps/{appSlug}/browser/sessions

Authorization

cloady
AuthorizationBearer <token>

Personal API token (cldy_…)

In: header

Path Parameters

workspaceSlug*string
appSlug*string

Query Parameters

env?string

Value in

  • "production"
  • "preview"
  • "development"
region?string
range?string

How far back to look; the answer has 30 to 96 points across it

Default"1h"

Value in

  • "15m"
  • "1h"
  • "6h"
  • "24h"
  • "7d"
filter?array<>

Filters, each written <field><op><value> with op =, !=, =~ or !~; =~ and !~ take a regular expression matched against the whole value, ignoring case. Repeat the parameter for several; every one must hold

Itemsitems <= 20
lens?string

errors, rage, dead, slow (LCP over 4 s), converted, or all

Default"all"

Value in

  • "all"
  • "errors"
  • "rage"
  • "dead"
  • "slow"
  • "converted"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/workspaces/string/apps/string/browser/sessions"
{  "start": 0,  "step": 0,  "query": "string",  "kpis": {    "active": 0,    "sessions": 0,    "duration": 0,    "errors": 0,    "frustrated": 0  },  "series": {    "active": [      0    ],    "sessions": [      0    ],    "duration": [      0    ],    "errors": [      0    ],    "frustrated": [      0    ]  },  "lenses": {    "all": 0,    "errors": 0,    "rage": 0,    "dead": 0,    "slow": 0,    "converted": 0  },  "sessions": [    {      "id": "string",      "start": 0,      "last": 0,      "live": true,      "user": "string",      "entry": "string",      "page": "string",      "pages": 0,      "errors": 0,      "rage": 0,      "dead": 0,      "lcp": 0,      "converted": true,      "device": "string",      "browser": "string",      "os": "string",      "country": "string",      "replay": true    }  ]}

Read Web Vitals and JavaScript errors from real browsers GET

Returns the 75th percentile of LCP, INP, CLS, FCP and TTFB with rating shares, a chart and breakdowns by device, browser and country, the most viewed pages, JavaScript error groups with a recorded session for each, page views and bounce, the fetch and XHR calls pages make, and visitors' browsers, systems and countries. Filter fields: `route` (the page template), `device`, `browser`, `os` and `country`.

Read one browser session GET

Returns the session's summary and every page view, vital, error, network call, rage or dead click and custom event it sent, oldest first.