Get weight monitoring (GET /api/public/monitoring/weight)

Weight monitoring: weight-inactive trainees, significant weight changes vs an aged baseline (with daysBetweenWeights), trend vs goal, plateaus, and broken weekly weigh-in streaks (streakBroken).

Authentication

Requires an API key, sent as Authorization: Bearer cp_live_....

API keys carry scopes. Get the catalog of scopes and webhook events lists every scope.

Query parameters

Query parameters
Name	Type	Description
`gender`	`string`	Filter trainees by gender Allowed values: `males` `females`
`labels`	`string[]`	Filter to trainees that have all of these label ids Maximum items: `100`
`trainingDays`	`string`	Days without training before a trainee counts as inactive (default 3)
`nutritionDays`	`string`	Days without nutrition logging before inactive (default 3)
`waterDays`	`string`	Days without water logging before inactive (default 3)
`weightDays`	`string`	Days without a weight entry before inactive (default 7)

Request examples

cURL

curl --request GET \
  --url 'https://api.coach-platform.com/api/public/monitoring/weight' \
  --header 'Authorization: Bearer cp_live_...'

JavaScript (fetch)

const response = await fetch('https://api.coach-platform.com/api/public/monitoring/weight', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer cp_live_...',
  },
});

const data = await response.json();

Responses

`200` OK

Successful response

Example body (application/json)

{
  "data": {}
}

Response fields (1)

Response fields
Name	Type	Description
`data`	`object`

Error responses

400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
409 Conflict
429 Too Many Requests
500 Internal Server Error

These statuses share the same response body.

Example body (application/json)

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "fix": "<string>",
    "details": {},
    "retryAfterMs": 123
  }
}

Error fields (6)

Error fields
Name	Type	Description
`error`	`object`
`error.code`	`string`
`error.message`	`string`
`error.fix`	`string \| null`
`error.details`	`object \| null`
`error.retryAfterMs`	`number \| null`

This page is also available as Markdown. Browse it in the interactive explorer or download the OpenAPI spec.