Sign in
analytics

Patients of a retention cell

Paginated patients of a single retention cell: the cohort registered at cohort_start that was active at the given period_offset. Coordinator role sees only patients under their supervisors.

get/api/analytics/retention/cohort-patients

Query parameters

cohort_startstring date required

Cohort registration period start (YYYY-MM-DD): week Monday or month first day.

Cohort registration period start (YYYY-MM-DD): week Monday or month first day.

period_offsetinteger required

Periods after registration (the matrix column).

Periods after registration (the matrix column).

granularitystring

Cohort granularity: week or month (must match the matrix).

Cohort granularity: week or month (must match the matrix).

target_statusesstring nullable

Comma-separated status keys (e.g. attivo,mai pagato). Empty for all.

Comma-separated status keys (e.g. attivo,mai pagato). Empty for all.

per_pageinteger

Page size.

Page size.

pageinteger

Page number (1-based).

Page number (1-based).

Response

Successful Response

granularitystring required

Cohort granularity: week or month

cohort_startstring date required

Registration period from_date of the cohort

period_offsetinteger required

Periods after registration (the cell column)

period_startstring date required

Start of the period at that offset (cohort_start + period_offset)

totalinteger required

Patients in the cell (matches the matrix cell count)

per_pageinteger required
pageinteger required

Changes

No recorded changes to this endpoint across all 1 revision of this API.