Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Lokhy87/gymApp/llms.txt

Use this file to discover all available pages before exploring further.

The Progress screen lets you pick any exercise from your history and draw a line chart showing how the weight you lifted has evolved over a chosen time window. The horizontal axis shows dates, the vertical axis shows kilograms, and each point on the line corresponds to a single workout entry. Use this view to spot upward trends, identify plateaus, and decide when to push for a new personal best.

Using the progress chart

1

Open Progress from the sidebar

Navigate to Progress in the main navigation. The exercise dropdown is populated from the full exercise catalog via GET /api/exercises.
2

Choose an exercise

Select the exercise you want to analyze from the Exercises dropdown. The list shows every exercise in the library, not only the ones you have logged — make sure to pick one you have actually tracked.
3

Set the time range

Choose a time window using the radio buttons: 3 mo, 6 mo, or 12 mo. The default is 6 months. The API uses this value to calculate how far back to look.
4

Apply

Click Apply. The chart updates with one data point per matching workout entry, ordered chronologically from oldest to newest.

Reading the chart

  • Each point on the line is one saved workout entry for the selected exercise.
  • The y-axis shows the weight in kilograms recorded for that session.
  • The x-axis shows the date formatted as YYYY-MM-DD.
  • The shaded area beneath the line helps you see the overall trend at a glance.
  • If there are no entries in the selected window, the chart renders empty axes with no data points.

API reference

GET /api/progress

curl "https://api.gymflow.example/api/progress?exercise=Bench+Press&months=6" \
  -H "Authorization: Bearer <token>"
Query parameters
ParameterTypeRequiredDescription
exercisestringYesExact name of the exercise (case-sensitive, matched against the name field in the exercises table)
monthsintegerNoHow many months back to include. Defaults to 6 if omitted
Response — 200 OK
[
  { "date": "2025-11-28", "weight": 72.5, "sets": 3, "reps": 10 },
  { "date": "2025-12-05", "weight": 75.0, "sets": 3, "reps": 10 },
  { "date": "2026-01-09", "weight": 77.5, "sets": 4, "reps":  8 },
  { "date": "2026-02-14", "weight": 80.0, "sets": 4, "reps":  8 },
  { "date": "2026-04-03", "weight": 82.5, "sets": 4, "reps":  6 },
  { "date": "2026-05-19", "weight": 85.0, "sets": 5, "reps":  5 }
]
The results are ordered by date ascending so the chart always draws left-to-right in time order. The sets and reps fields are included in the response even though the current chart only plots weight; they are available if you build additional visualizations.
For a meaningful chart, choose an exercise you have logged at least five or six times spread across the selected window. An exercise you performed only once or twice produces a nearly flat line with a single segment and is difficult to interpret. If your chart looks sparse, try widening the range to 12 months or switch to a more frequently performed exercise.

Supported time ranges

The UI exposes three preset windows that map directly to the months parameter:
UI labelmonths valueLookback period
3 mo3Last 3 calendar months from today
6 mo6Last 6 calendar months from today (default)
12 mo12Last 12 calendar months from today
The server calculates the cutoff date at request time by subtracting the requested number of months from the current date, so the window always ends at today and slides backward.

Workout history

Browse every logged entry in the monthly calendar view.

Log a workout

Add new entries that will appear in your progress chart.

Progress API

Full endpoint reference for the progress resource.

Exercise library

Browse exercises by muscle group to find the right movement to track.

Build docs developers (and LLMs) love