---
title: "Get the patient's summary for the clinician view"
method: GET
path: "/patients/patient_engagement_summary"
tags: ["patient_report"]
---

# Get the patient's summary for the clinician view

`GET /patients/patient_engagement_summary`

## Query parameters

- `patient_ids_to_include` string
- `patient_ids_to_exclude` string
- `date_since` string, required — reference date (today's date) in format YYYY-MM-DD
- `date_until` string, required — reference date (today's date) in format YYYY-MM-DD

## Response `200`

successful operation

- WeeklyPatientEngagementResponse
  - `patient_id` integer, required
  - `sex` string, nullable
  - `tracking_start_date` string
  - `weeks` WeeklyPatientEngagementRowResponse[], required
    - `avg_calcium_mg` number, required
    - `avg_calories_kcal` number, required
    - `avg_carbs_g` number, required
    - `avg_dash_score` number, nullable, required
    - `avg_fat_g` number, required
    - `avg_fiber_g` number, required
    - `avg_iron_mg` number, required
    - `avg_protein_g` number, required
    - `avg_sodium_mg` number, required
    - `avg_sugars_g` number, required
    - `avg_vitamin_b12_ug` number, required
    - `avg_vitamin_d_iu` number, required
    - `date_since` string, date-time, required
    - `date_until` string, date-time, required
    - `frequency_fish` number, required
    - `frequency_fried` number, required
    - `frequency_high_fiber` number, required
    - `frequency_high_processed` number, required
    - `frequency_low_fiber` number, required
    - `frequency_min_processed` number, required
    - `frequency_not_fried` number, required
    - `frequency_plant` number, required
    - `frequency_poultry` number, required
    - `frequency_redmeat` number, required
    - `hei_score` number, nullable, required
    - `n_audio_queue_searches` number
    - `n_breakfast_items` number, required
    - `n_breakfast_logs` number, required
    - `n_days` number, required
    - `n_dinner_items` number, required
    - `n_dinner_logs` number, required
    - `n_lunch_items` number, required
    - `n_lunch_logs` number, required
    - `n_nlp_queue_searches` number
    - `n_nlp_searches` number, required
    - `n_photo_ffe_queue_searches` number
    - `n_photo_ffe_searches` number, required
    - `n_photo_searches` number, required
    - `n_snack_items` number, required
    - `n_snack_logs` number, required
    - `n_text_searches` number, required

---

[API](https://skmtc.dev/rxfoodapp/apis/inneranalytics-mnt-server.md) · [All operations](https://skmtc.dev/rxfoodapp/apis/inneranalytics-mnt-server/llms.txt) · [OpenAPI document](https://skmtc.dev/rxfoodapp/apis/inneranalytics-mnt-server/revisions/081a2697c0f1?raw)