Sign in
Docs
Have a token? Manage tokens in the console
GET
/v1/summaries

What happened on the account in a window of time: the incidents that opened and resolved, the monitors that went down and came back, and the decisions that ended. Built from the platform's own records, never by a model, so the same window always gives the same answer. lines and markdown say it in plain words, with links to the console.

Needs scope summaries: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

account_id?string

Empty for the key's own account; any other account is NOT_FOUND.

from?string

The window's start, RFC 3339. With from, window is ignored.

to?string

The window's end, RFC 3339; empty means now.

window?string

24h, 7d and the like, at most 31d; empty means 24h.

Response Body

iohr.summaries.v1.RequestResponse

application/json
  1. response

iohr.summaries.v1.RequestResponse

summary?

iohr.summaries.v1.Summary

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.summaries.request();  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.

{  "summary": {    "account_id": "string",    "account_name": "string",    "built_from": [      "string"    ],    "decisions": [      {        "decided_at": "string",        "document_id": "string",        "kind": "string",        "number": 0,        "space_id": "string",        "status": "string",        "title": "string",        "url": "string"      }    ],    "from": "string",    "incidents_opened": [      {        "duration_seconds": "string",        "incident_id": "string",        "opened_by_alert": true,        "resolved_at": "string",        "severity": 0,        "started_at": "string",        "status": "string",        "title": "string",        "url": "string"      }    ],    "incidents_resolved": [      {        "duration_seconds": "string",        "incident_id": "string",        "opened_by_alert": true,        "resolved_at": "string",        "severity": 0,        "started_at": "string",        "status": "string",        "title": "string",        "url": "string"      }    ],    "lines": [      "string"    ],    "markdown": "string",    "monitors": [      {        "down_seconds": "string",        "monitor_id": "string",        "name": "string",        "recovered": 0,        "still_down": true,        "url": "string",        "went_down": 0      }    ],    "quiet": true,    "to": "string"  }}