InOrbitdocs
Sign in
Docs
Have a token? Manage tokens in the console
GET
/v1/trails/recordings

The account's trail recordings (RFC 0055), newest first, without their events: each one's site, client, when it started and was kept, how many events it holds and how many were dropped by the client or by the service. Admins only until trails open.

Needs scope trail:read.

Authorization

bearer
headerAuthorizationBearer <token>

An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (docs.inorbit.hr). The gateway verifies it; the audience is iohr-api.

Query Parameters

query?string

Part of the site, any case.

page_size?integer

At most this many; 0 means 50, above 200 means 200.

Formatint32
page_token?string

From the previous page's next_page_token.

Response Body

iohr.trails.v1.ListRecordingsResponse

application/json
  1. response

iohr.trails.v1.ListRecordingsResponse

next_page_token*string
recordings*array<>
import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try {  for await (const recording of api.trails.allListRecordings()) {    console.log(recording);  }} catch (e) {  if (!(e instanceof ApiError)) throw e;  console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`);}

npm install @inorbithr/sdk. Calls the package's public surface; an operation newer than your package needs the next release or a client generated for your account. The SDKs.

{  "next_page_token": "string",  "recordings": [    {      "account_id": "string",      "bytes": 0,      "client": "string",      "created_at": "string",      "created_by": "string",      "dropped": 0,      "duration_ms": 0,      "event_count": 0,      "events": [        {          "fields": {            "property1": {              "bool_value": true,              "list_value": {                "values": [                  {}                ]              },              "null_value": "NULL_VALUE",              "number_value": 0.1,              "string_value": "string",              "struct_value": {}            },            "property2": {              "bool_value": true,              "list_value": {                "values": [                  {}                ]              },              "null_value": "NULL_VALUE",              "number_value": 0.1,              "string_value": "string",              "struct_value": {}            }          }        }      ],      "pages": 0,      "recording_id": "string",      "rejected": 0,      "site": "string",      "started_at": "string"    }  ]}

Get a publisher GET

A publisher's namespace, name, proved domain and whether it is InOrbit, with how many of its listings the account may see. Needs scope `extensions:read`.

Get a recording GET

One recording with its events, each `{k, t, ...fields}`: pages, clicks with a role, a name and a selector, scroll depth, focus and visibility, timings and the Core Web Vitals, long tasks, scrubbed errors, rage and dead clicks. Never anything typed. Needs scope `trail:read`.