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 endpoint returns chronologically sorted workout data for a single exercise within a rolling time window. It is designed to power progress charts: each item represents one logged session, giving you the date alongside the performance values. This endpoint requires a valid JWT. See Authentication for how to obtain a token.

Get exercise progress

GET /api/progress
exercise
string
required
The exact name of the exercise to query. Must match the exercise_name field returned by GET /api/history or the name field from GET /api/exercises.
months
integer
How many months of history to include, counting back from today. Defaults to 6 when omitted. Use months=12 for a full year view.
Example request — default 6-month window
curl "https://api.gymflow.example/api/progress?exercise=Bench%20Press" \
  -H "Authorization: Bearer <your_token>"
Example request — custom 12-month window
curl "https://api.gymflow.example/api/progress?exercise=Bench%20Press&months=12" \
  -H "Authorization: Bearer <your_token>"
Example response — 200 OK
[
  {
    "date": "2024-01-08",
    "weight": 70.0,
    "sets": 4,
    "reps": 8
  },
  {
    "date": "2024-01-22",
    "weight": 72.5,
    "sets": 4,
    "reps": 8
  },
  {
    "date": "2024-02-05",
    "weight": 75.0,
    "sets": 4,
    "reps": 9
  }
]
Results are ordered by date ascending, oldest first. An empty array [] is returned when no workouts for that exercise fall within the requested window.
date
string
The date the workout was logged, formatted as Y-m-d (e.g. "2024-02-05").
weight
float
Weight used during that session. Returns 0 when no weight was recorded.
sets
integer
Number of sets logged in that session.
reps
integer
Number of repetitions per set logged in that session.
Exercise name matching is case-sensitive and must be an exact string match. "bench press" and "Bench Press" are treated as different exercises. Use the name values from GET /api/exercises or the exercise_name values from GET /api/history to ensure the string is correct.
Error responses
StatusMeaning
400The exercise query parameter is missing.
401Missing or invalid Bearer token.

Build docs developers (and LLMs) love