Skip to main content
POST
Preview Cohort Count

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

tz
string | null

Client timezone for day-based filter calculations

Body

application/json
filterCriteria
CohortFilters · object
required

Reusable cohort filter fields (no pagination/sort/transport).

Field list mirrors PatientFetchParams in decoda/schemas/patient.py; keep in sync or explicitly diverge. The two schemas are intentionally decoupled so cohort and patient-table can evolve independently.

Response

Successful Response

total
integer
required
patients
CohortPatientCountPatient · object[]
failedCohortIds
string[] | null
patientCountError
boolean
default:false