Sign in
InOrbit
Docs

API reference

Get an error group

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

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.

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.

Path Parameters

group_id*string

The group's id, terr_ and a ULID, from List error groups.

Response Body

iohr.trails.v1.GetErrorGroupResponse

application/json
  1. response

iohr.trails.v1.GetErrorGroupResponse

group?

iohr.trails.v1.ErrorGroup

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.getErrorGroup("<group_id>");  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.

{  "group": {    "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  }}

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

Get narration settings GET

The account's narration settings (RFC 0089.1): the ElevenLabs connection it narrates through, its own monthly character cap and the cap that applies under its plan. Narration is on the Personal plan and up. Needs scope `narration:read`.