Sign in
InOrbit
Docs

API reference

Report a failed request

Have a token? Manage tokens in the console
POST
/v1/trails/errors

Report one failed request seen on a page or in an app (PRD 0011): its request ID, traceparent, method, route as a template (ids become :id, no query), page route and status, or network / timeout with status 0. Never a body, a value or anything personal. Similar reports are grouped and each group is investigated on its own; the answer goes to the team. A signed-in caller reports into their own account; a site configured for it reports without one. Client errors other than 408 and 429 are not kept (accepted: false).

Needs scope trail:write.

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 (developers.inorbit.hr). The gateway verifies it; the audience is iohr-api.

Request Body

iohr.trails.v1.ReportErrorRequest; path variables override their fields

application/json
  1. body

iohr.trails.v1.ReportErrorRequest

client?string
error_class?string
method?string
occurred_at?string
page_route?string
request_id?string
route?string
site?string
status?integer
Formatint32
traceparent?string

Response Body

iohr.trails.v1.ReportErrorResponse

application/json
  1. response

iohr.trails.v1.ReportErrorResponse

accepted*boolean
group_id*string
import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try {  const { value } = await api.trails.reportError({    client: "<client>",    error_class: "<error_class>",    method: "<method>",    occurred_at: "<occurred_at>",  });  console.log(value);} 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.

{  "accepted": true,  "group_id": "string"}

Delete a recording DELETE

The recording and its events are deleted at once. Needs scope `trail:write`.

List error groups GET

The account's groups of similar failed requests, newest first: site, method, route template, status, how many and when, with each group's investigation once it has run (what is known, what is assumed, what can't be proven). Needs scope `trail:read`.