Cloady Docs
API ReferenceEndpointsApplications

Read browser monitoring

Returns the app's public browser key, the script URL and the hosts allowed to send beacons, from which the snippet is built, when the newest beacon arrived and the settings its snippet carries, and LCP p75 and active sessions over the range once pages send beacons. Browser monitoring is on exactly while the app's pages carry the snippet, and its settings (replay share, masking, conversion goal) live in the snippet itself, so turning it off means removing the snippet.

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

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"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/workspaces/string/apps/string/browser"
{  "key": "string",  "script": "string",  "endpoint": "string",  "hosts": [    "string"  ],  "lastSeen": 0,  "config": {    "method": "tag",    "replay": 0,    "mask": "text",    "goal": "string"  },  "pulse": {    "start": 0,    "step": 0,    "lcp": 0,    "active": 0,    "lcpSeries": [      0    ],    "activeSeries": [      0    ]  }}

List the values a service's filters can take GET

Returns, for each filter field of a Monitor view, the values seen in the service's data within the range, most frequent first: log levels and routes from its logs, routes, methods and status classes from its ingress access log or its OpenTelemetry spans, and pages, devices, browsers, systems and countries from browser monitoring. `serviceName` is a compose service.

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`.