Cloady Docs
API ReferenceEndpointsApplications

Download a session recording

Returns the session's recording as compressed rrweb segments, masked in the visitor's browser. A long session can return several megabytes. Needs the developer role, since recordings show what the app's visitors saw.

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

Authorization

cloady
AuthorizationBearer <token>

Personal API token (cldy_…)

In: header

Path Parameters

workspaceSlug*string
appSlug*string
sessionId*string

Query Parameters

env?string

Value in

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

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/string/replay"
{  "segments": [    {      "seg": 0,      "part": 0,      "parts": 0,      "t0": 0,      "t1": 0,      "mask": "string",      "data": "string"    }  ],  "truncated": true}

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.

Read an app's tracing setting GET

Returns whether tracing is on, which is whether the app holds the variable OTEL_EXPORTER_OTLP_ENDPOINT, the OpenTelemetry variables each compose service gets while it is, and which services have sent spans in the last 7 days. Spans need an OpenTelemetry SDK or agent in the app.