Sign in
insights

Gets the AI-generated weekly cover summary for a patient's report window

get/patients/{patient_id}/insights/weekly-cover-summary

Path parameters

patient_idinteger required

Query parameters

date_sincestring required

calendar date in format YYYY-MM-DD

Example:2025-01-01
date_untilstring required

calendar date in format YYYY-MM-DD

Example:2025-01-07
force_rebuildboolean

force the rebuild of the weekly cover summary

Response

successful operation

behavior_patternsstring[]
date_sincestring date required

window start date

date_untilstring date required

window end date

diet_quality_overviewstring required

brief diet-quality interpretation for the week

executive_summarystring required

3-4 sentence executive summary for the week

idinteger

id of the weekly cover summary

internal_reasoningstring nullable

internal reasoning for the weekly summary, in English

suggested_questionsstring[]
versionstring required

version of the weekly cover summary response

Example response

{
  "date_since": "2025-01-01",
  "date_until": "2025-01-07",
  "id": 1,
  "meal_insights": [
    {
      "meal_id": 123
    }
  ],
  "pinned_nutrient_insights": [
    {
      "nutrient_key": "fiber_g"
    }
  ],
  "recommended_challenge": {
    "challenge_id": "choose-better-fats",
    "challenge_name": "Choose Better Fats"
  },
  "version": "v0.1"
}

Changes

No recorded changes to this endpoint across all 15 revisions of this API.