API referenceImpact
API reference
Get impact
Have a token? Manage tokens in the console
GET
The account's impact counts now: each client's last snapshot, the totals across them, and where they are kept (retained).
Needs scope impact:read.
bearerheader
AuthorizationBearer <JWT>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.
client?stringOnly this assistant client in clients, claude or codex; empty for all. The totals cover every client.
iohr.impact.v1.GetImpactResponse
application/json- response
iohr.impact.v1.GetImpactResponse
counts?iohr.impact.v1.Counts
retained*stringseq*stringFormat
int64updated_at*stringSDK
HTTP
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.impact.getImpact(); console.log(value);} catch (e) { if (!(e instanceof ApiError)) throw e; console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`); process.exitCode = 1;}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.
Example Response
{ "counts": { "all": { "approx": true, "caught_rate": { "high": 0.1, "k": "string", "low": 0.1, "n": "string", "rate": 0.1 }, "client": "string", "corrections": { "by_class": { "property1": "string", "property2": "string" }, "by_fixer": { "property1": "string", "property2": "string" }, "by_stage": { "property1": "string", "property2": "string" }, "cells": [ { "class": "string", "fixer": "string", "n": "string", "stage": "string" } ], "ids": [ "string" ], "total": "string" }, "lookups": { "declined": "string", "failed": "string", "named": "string", "ok": "string", "total": "string" }, "method": "string", "named_rate": { "high": 0.1, "k": "string", "low": 0.1, "n": "string", "rate": 0.1 }, "ok_rate": { "high": 0.1, "k": "string", "low": 0.1, "n": "string", "rate": 0.1 }, "sessions": "string", "writes": { "declined": "string", "failed": "string", "ok": "string", "total": "string" } }, "clients": [ { "approx": true, "caught_rate": { "high": 0.1, "k": "string", "low": 0.1, "n": "string", "rate": 0.1 }, "client": "string", "corrections": { "by_class": { "property1": "string", "property2": "string" }, "by_fixer": { "property1": "string", "property2": "string" }, "by_stage": { "property1": "string", "property2": "string" }, "cells": [ { "class": "string", "fixer": "string", "n": "string", "stage": "string" } ], "ids": [ "string" ], "total": "string" }, "lookups": { "declined": "string", "failed": "string", "named": "string", "ok": "string", "total": "string" }, "method": "string", "named_rate": { "high": 0.1, "k": "string", "low": 0.1, "n": "string", "rate": 0.1 }, "ok_rate": { "high": 0.1, "k": "string", "low": 0.1, "n": "string", "rate": 0.1 }, "sessions": "string", "writes": { "declined": "string", "failed": "string", "ok": "string", "total": "string" } } ] }, "retained": "string", "seq": "string", "updated_at": "string"}