Skip to main content
GET
Get a week's stats

Authorizations

Authorization
string
header
default:Bearer sandbox_any_token_works
required

A 15-minute token bound to one patient and one enrollment, issued by POST /v1/oauth/token with the token-exchange grant. Treat it as opaque. When it expires, exchange a fresh assertion; there is no refresh token.

Query Parameters

week_number
integer

Omit for the current week.

Required range: 1 <= x <= 520

Response

The week.

week_number
integer
required

The treatment week, the same number as treatment_week on GET /v1/patient/treatment.

Required range: x >= 1
Example:

6

start_date
string<date>
required

A calendar date in the patient's time zone.

Example:

"2026-10-26"

end_date
string<date>
required

A calendar date in the patient's time zone.

Example:

"2026-10-26"

days_logged
integer
required

Days with anything logged. For the current week, counts up to today.

Required range: 0 <= x <= 7
Example:

5

logging_streak_days
integer
required

Days in a row with anything logged, up to the end of the week (or today).

Example:

12

protein
object
required
calories_avg_kcal
integer | null
required
Example:

1480

water
object
required
workouts
object
required
steps_avg
integer | null
required
Example:

7400

weight
object
required
injections
object
required
symptoms
object
required
milestones
object[]
required

Milestones reached during the week.