Today

Stop the running experiment

Keeps its days and reports nothing from them.

post/training/experiments/{id}/stop

Request

  • Base URL: https://bodylab.lol/api/v1
  • URL: https://bodylab.lol/api/v1/training/experiments/{id}/stop
  • Auth: HTTP bearer

Path parameters

idstring required

Opaque identifier.

Headers

X-Client-Platformstring

The native client's platform, e.g. ios. Server-side and non-native callers omit it.

X-Client-Versionstring

The native client's own semver version. With X-Client-Platform, a version below that platform's minimum is refused with CLIENT_UPGRADE_REQUIRED (426).

Response

OK

idstring required

Opaque identifier.

exposurestring required
labelstring required
armRulestring required

remove or add. Known values: remove, add. Treat unknown values as "other".

statusstring required

running, finished or stopped. A stopped one keeps its days and reports nothing. Known values: running, finished, stopped. Treat unknown values as "other".

startsOnstring date required

The first arm's night.

lastAnswerOnstring date required

The morning of the last answer: starts_on + 14.

schedulestring required

Fourteen nights, A (the arm) or B (as usual), starts_on first, fixed when it began.

tonightstring nullable required
keptNightsinteger required
answeredNightsinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.