---
title: "Registered patients behind one cell of the A/B flows card"
method: GET
path: "/api/analytics/registered-patients/flows/patients"
tags: ["analytics"]
---

# Registered patients behind one cell of the A/B flows card

`GET /api/analytics/registered-patients/flows/patients`

## Request

- Base URL: `https://api.corabea.it` (the document declares no server; this is the origin it was published from)
- URL: `https://api.corabea.it/api/analytics/registered-patients/flows/patients`
- Auth: HTTP bearer

Same payload as registered-patients, restricted to one variant, its call bookers or the patients in no test.

## Query parameters

- `from_date` string, date, required: Start day (YYYY-MM-DD), inclusive.
- `to_date` string, date, required: End day (YYYY-MM-DD), inclusive.
- `experiment` string, nullable: Experiment key: its counted patients. Omitted: the patients in no test.
- `variant` string, nullable: With experiment: only this variant key.
- `call` 'free_call' | 'intro_call' | 'complimentary_intro_call' | 'daily_opened' | 'exercise_done', nullable: With experiment: only who booked this call after the assignment.
- `out_reason` 'no_questionnaire' | 'legacy_questionnaire' | 'not_assigned' | 'excluded', nullable: Without experiment: only the patients in no test for this reason.
- `sort_by` string: Sort column.
- `sort_dir` string: Sort direction: asc or desc.
- `per_page` integer: Page size.
- `page` integer: Page number (1-based).

## Response `200`

Successful Response

- RegisteredPatientRankingResponse: Registered-patients list: summary/funnel, applied filters, paginated rows.
  - `aggregates` RegisteredPatientAggregates, required: Summary metrics and activation funnel over the filtered cohort.
    - `total_patients` integer, required: Registered patients matching filters
    - `ios_patients` integer: Patients on iOS from latest native usage, falling back to the last-seen native device (including inactive devices)
    - `android_patients` integer: Patients on Android from latest native usage, falling back to the last-seen native device (including inactive devices)
    - `web_only_patients` integer: Patients with web usage/devices and no known native app platform
    - `platform_unknown_patients` integer: Patients without an iOS, Android or Web platform in usage or devices
    - `app_updated_patients` integer
    - `app_latest_versions` object
    - `app_version_known_patients` integer: Patients with a reported iOS/Android/Web version
    - `app_version_unknown_patients` integer: Patients without a reported iOS/Android/Web version
    - `app_updated_percentage` number, nullable: Patients on the latest version of their last reported platform / patients with a known version
    - `commercial_consent_patients` integer: Patients who agreed to commercial communications
    - `commercial_consent_percentage` number, nullable: Share of the cohort who agreed to commercial communications
    - `funnel` RegisteredPatientFunnelStep[]: Activation funnel, ordered
      - `step` string, required: Stage key
      - `count` integer, required: Patients who reached this stage
      - `pct` number, nullable: Percentage of the registered cohort
    - `avg_age_at_registration` number, nullable
    - `patients_with_birth_date` integer, required
    - `age_coverage_percentage` number, required
    - `age_ranges` RegisteredPatientAgeRangeAggregate[]
      - `range` 'under_18' | '18_24' | '25_34' | '35_44' | '45_54' | '55_plus', required
      - `patients` integer, required
      - `percentage` number, required
  - `filters` RegisteredPatientFilters, required: Applied filters and pagination for the registered-patients list.
    - `from_date` string, date, nullable
    - `to_date` string, date, nullable
    - `registration_method` string, nullable
    - `registration_reason` string, nullable
    - `email_status` string, nullable: verified / unverified
    - `search` string, nullable
    - `patient_id` string, uuid, nullable
    - `sort_by` string, required
    - `sort_dir` string, required
    - `per_page` integer, required
    - `page` integer, required
    - `total` integer, required: Patients matching filters before pagination
  - `rows` RegisteredPatientRow[], required
    - `patient_id` string, uuid, required: Patient UUID
    - `user_id` string, uuid, required: User UUID
    - `first_name` string, nullable
    - `last_name` string, nullable
    - `email` string, nullable
    - `phone` string, nullable
    - `registration_method` string, nullable: email / google / apple / facebook
    - `registration_reason` string, nullable: Reason selected at registration
    - `email_verified` boolean, nullable
    - `registered_at` string, date-time, nullable
    - `questionnaire_started_at` string, date-time, nullable
    - `questionnaire_completed_at` string, date-time, nullable
    - `questionnaire_type` string, nullable: Patient detail only: the questionnaire of questionnaire_completed_at, initial or initial_triage (its answers at /questionnaires/by-type/{type}, its PDF {type}.pdf)
    - `story_registration_opened_at` string, date-time, nullable
    - `story_registration_completed_at` string, date-time, nullable
    - `has_opened_journey_step` boolean: Whether the patient opened at least one journey step
    - `completed_journey_steps_count` integer: Completed journey steps
    - `free_call_booked_at` string, date-time, nullable
    - `free_call_done` boolean, nullable
    - `intro_call_booked_at` string, date-time, nullable
    - `intro_call_done` boolean, nullable
    - `corabea_plus_opened_at` string, date-time, nullable
    - `has_corabea_plus_subscription` boolean, nullable
    - `last_activity_at` string, date-time, nullable
    - `tracked_sessions` integer
    - `total_foreground_seconds` integer
    - `avg_session_seconds` number, nullable

## Other responses

- `422`: Validation Error

## Changes

- **2026-10-16** `841b592f039c`: 2 info
  - added the enum value `daily_opened` to the property `anyOf[subschema #1]/` of the `query` request parameter `call`
  - added the enum value `exercise_done` to the property `anyOf[subschema #1]/` of the `query` request parameter `call`
- **2026-10-16** `12d5032b075e`: 1 info
  - added the enum value `complimentary_intro_call` to the property `anyOf[subschema #1]/` of the `query` request parameter `call`
- **2026-10-16** `8d6ec7de589b`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/corabea/apis/corabea-api/changes/api/analytics/registered-patients/flows/patients/get.md)

---

[API](https://skmtc.dev/corabea/apis/corabea-api.md) · [All operations](https://skmtc.dev/corabea/apis/corabea-api/llms.txt) · [OpenAPI document](https://skmtc.dev/corabea/apis/corabea-api/revisions/64c5370369f5?raw)
