Skip to content

Commit b98f638

Browse files
committed
api descriptions
1 parent 5e4c3d9 commit b98f638

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

backend/README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,44 @@ Permanently deletes the authenticated user's profile and all associated data fro
124124

125125

126126

127+
## Settings
127128

129+
### GET /api/v1/settings
130+
131+
Response Body:
132+
```json
133+
{
134+
"captureIntervalSeconds": 30,
135+
"notificationsEnabled": true,
136+
"notificationSensitivity": "medium",
137+
"workingHoursEnabled": true,
138+
"workingHoursStart": "09:00:00",
139+
"workingHoursEnd": "17:00:00",
140+
"cameraIndex": 0,
141+
"theme": "dark"
142+
}
143+
144+
```
145+
### PUT api/v1/settings
146+
Updates those fields
147+
148+
### Analytics
149+
### GET /api/v1/analytics/weekly
150+
Weekly analytics
151+
Response Body:
152+
153+
```json
154+
{
155+
"totalEvents":54,
156+
"goodPostureCount":35,
157+
"badPostureCount":19,
158+
"averageSeverity":0.6,
159+
"goodPosturePercentage":0.7
160+
}
161+
```
162+
163+
### GET /api/v1/analytics/today
164+
In same format returns stats for today.
128165

129166

130167

0 commit comments

Comments
 (0)