API reference
Report impact counts
Push one snapshot of counts for one assistant client of your account. It replaces that client's earlier snapshot. Counts and ids only; any free text is refused.
Needs scope impact:write.
bearerAuthorizationBearer <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.
iohr.impact.v1.ReportImpactRequest; path variables override their fields
application/json- body
iohr.impact.v1.ReportImpactRequest
counts?iohr.impact.v1.ClientCounts
iohr.impact.v1.ReportImpactResponse
application/json- response
iohr.impact.v1.ReportImpactResponse
counts?iohr.impact.v1.ClientCounts
retained*stringseq*stringint64import { 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.reportImpact({}); 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.
{ "counts": { "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"}