Signals API

Version 2.0.0-0 · 39 operations

Generated from the OpenAPI document by npm run docs:openapi. Do not edit by hand —
change the decorators in src/ and regenerate, or the next run will overwrite you.

Vitals ingestion and alerting.

Authentication. Every route except /health uses HTTP Basic with an API
client's clientId and secret. The tenant is resolved server-side from that
credential and is never accepted from the request.

Roles. SUBMITTER posts readings for patients it is attached to,
SUBSCRIBER reads the records of patients it is attached to, MANAGER
administers the tenant, and ADMIN bypasses role checks.

Paging. Modern list routes use an opaque keyset cursor: pass the
nextCursor you were given back as cursor. Do not construct or parse one —
the encoding is not part of this contract. A malformed cursor is treated as "no
cursor" and returns the first page rather than an error.

Timestamps. Always ISO-8601 in UTC with a trailing Z, on the way in and
on the way out.

Sections

Section	Operations	What it covers
Observations	6	Submitting readings. This is the hot path: one POST per reading (or a batch), evaluated against the patient's triggers before the response returns unless the tenant is in async mode.
Alerts	6	Alerts raised by evaluation. An alert opens on a breach, deduplicates on its trigger key while it stays open, and closes when a reading returns to range.
Patients	5	Patients and their alerting flags. `refId` is the caller's own identifier.
Triggers	6	Per-patient alerting rules as json-logic, plus the bulk primitives that move a whole project's band in one statement.
Patient config	5	Config writes addressed by a list of patient ids, for the case the per-trigger and bulk-update routes do not cover: the caller holds the ids and wants one push. Reads are POSTs here too — a thousand ids do not fit in a query string.
Tenants	2	Tenant-level feature switches.
Clients	5	API credentials and their webhook subscriptions.
Provisioning	1	Opening a tenant and minting the credential that can act in it, in one transaction.
Audit	2	The append-only record of configuration changes.
Health	1	Liveness plus the pipeline check that alarms when readings arrive and nothing alerts, or alerts queue and nothing is delivered.
Schemas	—	Every response body shape.