Nutritional Reports & Summaries

Plan & Token Requirements

Feature available in the following LogMeal Plans:

Accessible by the following User Types:

What It Does

Nutritional Reports & Summaries aggregate a user's intakes to deliver day and week level summaries of energy and other nutrients and of food group consumption. They are ideal for progress dashboards, coaching check‑ins, and compliance reporting against Daily Nutritional Goals or Recommended Daily Intake.

✕

✕

When to Use It / Outcomes

• You want daily/weekly totals to populate dashboards and PDF/CSV exports.
• You need trend views for coaching or user self‑tracking.
• You want to compare consumption vs goals/recommendations for compliance badges.
• Output: JSON with totals per nutrient or per food group for a day or week.

Feature-Specific Details

• Daily summary aggregates all intakes of a single date ("%Y/%m/%d").
• Weekly summary aggregates seven days starting from date ("%Y/%m/%d").
• Per‑nutrient totals include energy (kcal), macros and, in higher plans, micronutrients available to your account.
• Per‑food group totals include daily and weekly consumption of the available food groups (meat, fish, vegetables, fruit, etc.).
• Localization: use language to localize dish/ingredient labels in list views. The user-specific language will be used default.
• User scope: pass user_id for 🔵 APIUserManager / ⚫ APICompany; for 🔴 APIUser, it defaults to the token user.
• Timezone: date boundaries respect the user timezone used by history services.

Related Endpoints

Use the following endpoints to obtain summaries and totals:

• GET /history/getDailySummary → ⚫ 🔴 🔵 Daily nutrition summary for a given date.

• GET /history/getWeeklySummary → ⚫ 🔴 🔵 Weekly nutrition summary starting at date.

• Optional helpers:

  • GET /history/getIntakesList → ⚫ 🔴 🔵 Detailed list of intakes within a period for drill‑down reports.
  • GET /daily_nutritional_goal → ⚫ 🔴 🔵 Fetch goals to compute compliance deltas.

Typical Workflow

1. Choose granularity (day or week) and target date.
2. Request summary: call GET /history/getDailySummary or GET /history/getWeeklySummary.
3. (Optional) Fetch goals via GET /daily_nutritional_goal to compute remaining/compliance metrics.
4. Render reports: display totals and trends; enable CSV/PDF export as needed.