InOrbitdocs
Sign in
Docs
Have a token? Manage tokens in the console
GET
/v1/accounts/orgs/{org_id}/monitors/{monitor_id}/series

A range of a monitor's runs in equal buckets, read on the server: runs, passes, failures, uptime and the median, 95th and 99th percentile latency per bucket and over the range, and the failures by class. At most 500 buckets, within the 90 days runs are kept.

Needs scope connections: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 (docs.inorbit.hr). The gateway verifies it; the audience is iohr-api.

Path Parameters

org_id*string

The account's id: org in GET /v1/me.

monitor_id*string

The monitor's id, mon_ and a ULID, from List monitors.

Query Parameters

from?string

Start of the range, RFC 3339; 24 hours before to when empty.

to?string

End of the range, RFC 3339; now when empty.

bucket_secs?integer

Seconds per bucket, at least 60; 0 gives about 100 buckets.

Formatint32

Response Body

iohr.connections.v1.GetMonitorSeriesResponse

application/json
  1. response

iohr.connections.v1.GetMonitorSeriesResponse

bucket_secs*integer
Formatint32
buckets*array<>
failed*integer
Formatint32
failures*array<>
from*string
p50?integer
Formatint32
p95?integer
Formatint32
p99?integer
Formatint32
runs*integer
Formatint32
to*string
uptime?number
Formatdouble
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.connections.getMonitorSeries("<org_id>", "<monitor_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.

{  "bucket_secs": 0,  "buckets": [    {      "failed": 0,      "p50": 0,      "p95": 0,      "p99": 0,      "passed": 0,      "runs": 0,      "seen": 0,      "start": "string",      "uptime": 0.1    }  ],  "failed": 0,  "failures": [    {      "count": 0,      "error_class": "string",      "last_at": "string",      "last_run_id": "string"    }  ],  "from": "string",  "p50": 0,  "p95": 0,  "p99": 0,  "runs": 0,  "to": "string",  "uptime": 0.1}

Get a monitor's summary GET

Health and since when, uptime over 24 hours, 7 days and 30 days as fractions from 0 to 1, the median and 95th percentile latency, and the last failure. Needs scope `connections:read`.

Search extensions GET

The extensions catalogue (RFC 0073) the account may see, by publisher and name: InOrbit's own, the account's private listings, and public ones. Each listing has its kind, the publisher's description in the publisher's words, and its latest version. Another account's private listing never appears. Needs scope `extensions:read`.