Sign in
InOrbit
Docs

API reference

List error groups

Have a token? Manage tokens in the console
GET
/v1/trails/error-groups

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.

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.

Query Parameters

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

application/json
  1. response

iohr.trails.v1.ListErrorGroupsResponse

groups*array<>
next_page_token*string
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 errorGroup of api.trails.allListErrorGroups()) {    console.log(errorGroup);  }} 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.

{  "groups": [    {      "account_id": "string",      "count": 0,      "delivered_to": "string",      "error_class": "string",      "first_seen": "string",      "group_id": "string",      "investigated_at": "string",      "investigation": {        "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": {}          }        }      },      "last_seen": "string",      "method": "string",      "reports": [        {          "client": "string",          "occurred_at": "string",          "page_route": "string",          "request_id": "string",          "trace_id": "string"        }      ],      "route": "string",      "site": "string",      "status": 0    }  ],  "next_page_token": "string"}

Report a failed request POST

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

Get an error group GET

One error group with its most recent reports (request ID, trace id, page route, never a value) and its investigation in the answer shape of `investigate`: the question, known, assumed and can't-prove claims, each with its proof, and what would settle each gap. Needs scope `trail:read`.