Skip to main content

List Signals alert episodes

MethodPath
GET/v1/signals/alerts

Shared authentication, project scope, and response conventions.

Episode routes require signals_alerts:read to view. Ovok filters out episodes whose Patient is outside the caller’s readable scope. A non-null nextCursor means more results may remain even when filtering makes a page short.

Lists the project's episodes, newest first. Ovok asks Signals for results and removes episodes whose Patient is outside the caller's readable scope. Because filtering can make a page short, a non-null nextCursor means there may still be more results even when fewer than limit items were returned.

Query parameterAccepted values and meaning
statusOPEN or CLOSED, as reported by Signals.
sinceISO 8601 date-time with an offset.
acknowledgedtrue or false.
codesComma-separated LOINC codes.
limitInteger 1–50; defaults to 50.
cursorOpaque cursor previously returned by this route for this same project.

The result is { items, nextCursor }. Each item has id, patientId, signalsPatientId, code, and status, plus Signals episode fields. noteCount is the count of notes on the episode, including notes attached to its raw alerts; it can be null if the count could not be read.

curl --get 'https://api.sandbox.ovok.com/v1/signals/alerts' \
--header "Authorization: Bearer ${OVOK_TOKEN}" \
--data-urlencode 'status=OPEN' \
--data-urlencode 'acknowledged=false' \
--data-urlencode 'limit=20'
StatusMeaning
403Missing signals_alerts:read.
409 signals_episodes_disabledProject setting episodicAlerts is off. Use the raw-alert routes if those results are needed.
422Invalid query, unknown parameter, cursor from another project/list, or Signals rejected the filter.
503 signals_unavailableSignals could not be reached or returned an unusable response.