Signals API

Vitals ingestion and alerting.

Version 1.1 · 8 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 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. GET /compat/alert pages by alert id: pass the nextCursor you
were given back as cursor. A null nextCursor is the last page.

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

Sections

SectionOperationsWhat it covers
Compat (v1)8The v1 wire: registering a patient, configuring its triggers, submitting readings, attaching a submitter or subscriber, and reading the alerts that resulted. Kept byte-identical to what the existing clients already call.
SchemasEvery response body shape.

Did this page help you?