API Reference
Activity streams module for stream data management.
This module provides activity stream data operations, including retrieval, creation, and transformation of heart rate, power, cadence, elevation, speed, pace, and map streams.
Exports
- CRUD: get_activity_streams, get_activities_streams, get_public_activity_streams, get_activity_stream_by_type, get_public_activity_stream_by_type, create_activity_streams
- Utils: transform_activity_streams, transform_activity_streams_hr, is_stream_hidden, filter_visible_streams
- Schemas: ActivityStreams
- Models: ActivityStreams (ORM model)
- Constants: STREAM_TYPE_HR, STREAM_TYPE_POWER, STREAM_TYPE_CADENCE, STREAM_TYPE_ELEVATION, STREAM_TYPE_SPEED, STREAM_TYPE_PACE, STREAM_TYPE_MAP
ActivityStreams
Bases: BaseModel
Schema for activity stream data.
Attributes:
| Name | Type | Description |
|---|---|---|
id |
StrictInt | None
|
Unique stream identifier. |
activity_id |
StrictInt
|
Parent activity identifier. |
stream_type |
StrictInt
|
Stream type code (1-7). |
stream_waypoints |
list[dict]
|
Waypoint data points. |
strava_activity_stream_id |
StrictInt | None
|
Strava stream ID. |
hr_zone_percentages |
dict | None
|
HR zone breakdown. |
Source code in backend/app/activities/activity_streams/schema.py
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | |
ActivityStreamsModel
Bases: Base
ORM model for activity stream data.
Attributes:
| Name | Type | Description |
|---|---|---|
id |
Mapped[int]
|
Primary key, auto-incremented. |
activity_id |
Mapped[int]
|
FK to the parent activity. |
stream_type |
Mapped[int]
|
Stream type integer code. |
stream_waypoints |
Mapped[list]
|
JSON waypoint data. |
strava_activity_stream_id |
Mapped[int | None]
|
Strava stream ID. |
Source code in backend/app/activities/activity_streams/models.py
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 | |
create_activity_streams
create_activity_streams(activity_streams, db)
Bulk create activity streams.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
activity_streams
|
list[ActivityStreams]
|
List of stream schemas. |
required |
db
|
Session
|
Database session. |
required |
Raises:
| Type | Description |
|---|---|
HTTPException
|
On database errors. |
Source code in backend/app/activities/activity_streams/crud.py
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 | |
filter_visible_streams
filter_visible_streams(streams, activity)
Filter out streams hidden by the activity.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
streams
|
list[ActivityStreams]
|
List of stream ORM instances. |
required |
activity
|
Activity
|
The activity ORM instance. |
required |
Returns:
| Type | Description |
|---|---|
list[ActivityStreams]
|
Streams that are not hidden. |
Source code in backend/app/activities/activity_streams/utils.py
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 | |
get_activities_streams
get_activities_streams(activity_ids, token_user_id, db, activities=None)
Get streams for multiple activities.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
activity_ids
|
list[int]
|
List of activity IDs. |
required |
token_user_id
|
int
|
Authenticated user ID. |
required |
db
|
Session
|
Database session. |
required |
activities
|
list[Activity] | None
|
Pre-fetched activity list. |
None
|
Returns:
| Type | Description |
|---|---|
list[ActivityStreams]
|
List of activity streams. |
Raises:
| Type | Description |
|---|---|
HTTPException
|
On database errors. |
Source code in backend/app/activities/activity_streams/crud.py
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 | |
get_activity_stream_by_type
get_activity_stream_by_type(activity_id, stream_type, token_user_id, db)
Get a specific stream type for an activity.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
activity_id
|
int
|
The activity identifier. |
required |
stream_type
|
int
|
The stream type constant. |
required |
token_user_id
|
int
|
Authenticated user ID. |
required |
db
|
Session
|
Database session. |
required |
Returns:
| Type | Description |
|---|---|
ActivityStreams | None
|
The activity stream or None. |
Raises:
| Type | Description |
|---|---|
HTTPException
|
On database errors. |
Source code in backend/app/activities/activity_streams/crud.py
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 | |
get_activity_streams
get_activity_streams(activity_id, token_user_id, db)
Get all streams for an activity.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
activity_id
|
int
|
The activity identifier. |
required |
token_user_id
|
int
|
Authenticated user ID. |
required |
db
|
Session
|
Database session. |
required |
Returns:
| Type | Description |
|---|---|
list[ActivityStreams] | None
|
List of activity streams or None. |
Raises:
| Type | Description |
|---|---|
HTTPException
|
On database errors. |
Source code in backend/app/activities/activity_streams/crud.py
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 | |
get_public_activity_stream_by_type
get_public_activity_stream_by_type(activity_id, stream_type, db)
Get a public stream by type for an activity.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
activity_id
|
int
|
The activity identifier. |
required |
stream_type
|
int
|
The stream type constant. |
required |
db
|
Session
|
Database session. |
required |
Returns:
| Type | Description |
|---|---|
ActivityStreams | None
|
The activity stream or None. |
Raises:
| Type | Description |
|---|---|
HTTPException
|
On database errors. |
Source code in backend/app/activities/activity_streams/crud.py
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 | |
get_public_activity_streams
get_public_activity_streams(activity_id, db)
Get public streams for an activity.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
activity_id
|
int
|
The activity identifier. |
required |
db
|
Session
|
Database session. |
required |
Returns:
| Type | Description |
|---|---|
list[ActivityStreams] | None
|
List of activity streams or None. |
Raises:
| Type | Description |
|---|---|
HTTPException
|
On database errors. |
Source code in backend/app/activities/activity_streams/crud.py
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 | |
is_stream_hidden
is_stream_hidden(activity, stream_type)
Check if a stream type is hidden.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
activity
|
Activity
|
The activity ORM instance. |
required |
stream_type
|
int
|
The stream type constant. |
required |
Returns:
| Type | Description |
|---|---|
bool
|
True if the stream should be hidden. |
Source code in backend/app/activities/activity_streams/utils.py
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 | |
transform_activity_streams
transform_activity_streams(activity_stream, activity, db)
Transform a stream to a Pydantic schema.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
activity_stream
|
ActivityStreams
|
The stream ORM instance. |
required |
activity
|
Activity
|
The activity ORM instance. |
required |
db
|
Session
|
Database session. |
required |
Returns:
| Type | Description |
|---|---|
ActivityStreams
|
The activity stream as a schema. |
Source code in backend/app/activities/activity_streams/utils.py
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | |
transform_activity_streams_hr
transform_activity_streams_hr(activity_stream, activity, db)
Calculate HR zone percentages for a stream.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
activity_stream
|
ActivityStreams
|
The HR stream instance. |
required |
activity
|
Activity
|
The activity ORM instance. |
required |
db
|
Session
|
Database session. |
required |
Returns:
| Type | Description |
|---|---|
ActivityStreams
|
Schema with hr_zone_percentages set. |
Source code in backend/app/activities/activity_streams/utils.py
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 | |