-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathv5.yml
8278 lines (8276 loc) · 278 KB
/
v5.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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
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
98
99
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
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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
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
372
373
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
476
477
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
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.1.0
info:
description: The Terra API
title: TerraAPI
version: 2022.03.16
servers:
- url: https://api.tryterra.co/v2
security:
- apiKeyAuth: []
devIdAuth: []
paths:
/auth/authenticateUser:
post:
summary: Generate an authentication link
description: Generates a link to redirect an end user to for them to log in with their fitness data provider
tags:
- Authentication
operationId: AuthenticateUser
parameters:
- name: resource
in: query
description: resource to authenticate user with
schema:
type: string
required: true
- name: dev-id
in: header
description: your developer ID
required: true
schema:
type: string
example: testingTerra
- name: x-api-key
in: header
description: your API key
required: true
schema:
type: string
example: OtHJok60oQmT8zhnUWc4SWBJI7ztPTs88C0gOsJJ
requestBody:
content:
application/json:
schema:
type: object
properties:
language:
type: string
reference_id:
type: string
auth_success_redirect_url:
type: string
auth_failure_redirect_url:
type: string
required: false
responses:
'200':
description: Returned when authentication link could be successfully generated
content:
application/json:
schema:
type: object
properties:
status:
type: string
enum: [success, error]
description: indicates that the request was successful
example: success
user_id:
description: User ID for the user being created
type: string
example: 23dc2540-7139-44c6-8158-f81196e2cf2e
auth_url:
type: string
description: authentication URL the user must be redirected to
in order to link their account
example: https://www.fitbit.com/oauth2/authorize?response_type=code&client_id=23BBG9&scope=settings+nutrition+sleep+heartrate+electrocardiogram+weight+respiratory_rate+oxygen_saturation+profile+temperature+cardio_fitness+activity+location&state=bLqqjPie9ptwoWm6VBxHCu6JkkoWJp
'400':
description: Returned when one or more parameters is malformed - an appropriate
error message will be returned
content:
application/json:
schema:
type: object
properties:
message:
description: a detailed message describing the error
type: string
status:
type: string
enum: [success, error]
description: indicates that an error happened (value is error)
'403':
description: Returned when credentials (dev ID and API key) are invalid
content:
application/json:
schema:
type: object
properties:
message:
description: a detailed message describing the error
type: string
status:
type: string
enum: [success, error]
description: indicates that an error happened (value is error)
'404':
description: Returned when a parameter does not exist on Terra's end (e.g.
resource)
content:
application/json:
schema:
type: object
properties:
message:
description: a detailed message describing the error
type: string
status:
type: string
enum: [success, error]
description: indicates that an error happened (value is error)
/auth/generateWidgetSession:
post:
summary: Generate an authentication link, using the Terra Authentication Widget
description: Generates a link to redirect an end user to for them to select an integration and log in with their fitness data provider
tags:
- Authentication
operationId: GenerateWidgetSession
parameters:
- name: dev-id
in: header
description: your developer ID
required: true
schema:
type: string
example: testingTerra
- name: x-api-key
in: header
description: your API key
required: true
schema:
type: string
example: OtHJok60oQmT8zhnUWc4SWBJI7ztPTs88C0gOsJJ
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/WidgetSessionParams"
required: true
responses:
'200':
description: Returned when authentication link could be successfully generated
content:
application/json:
schema:
type: object
properties:
session_id:
description: Session ID for the widget authentication session
type: string
example: 23dc2540-7139-44c6-8158-f81196e2cf2e
url:
type: string
description: the widget URL the user must be redirected to
in order to link their account
example: https://widget.tryterra.co/session/344d475f-296a-489a-a88c-54183671dafd
status:
type: string
enum: [success, error]
description: indicates that an error happened (value is success)
example: success
expires_in:
type: number
description: a number in seconds depicting how long the url is valid for
example: 900
'400':
description: Returned when one or more parameters is malformed - an appropriate
error message will be returned
content:
application/json:
schema:
type: object
properties:
message:
description: a detailed message describing the error
type: string
status:
type: string
enum: [success, error]
description: indicates that an error happened (value is error)
'403':
description: Returned when credentials (dev ID and API key) are invalid
content:
application/json:
schema:
type: object
properties:
message:
description: a detailed message describing the error
type: string
status:
type: string
enum: [success, error]
description: indicates that an error happened (value is error)
/auth/deauthenticateUser:
delete:
summary: Deauthenticates a user and deletes any cached data for them
description: Deletes all records of the user on Terra's end, revoking Terra's access to their data
tags:
- Authentication
operationId: DeauthenticateUser
parameters:
- name: user_id
in: query
description: user_id to deauthenticate for
schema:
type: string
required: true
- name: dev-id
in: header
description: your developer ID
required: true
schema:
type: string
example: testingTerra
- name: x-api-key
in: header
description: your API key
required: true
schema:
type: string
example: OtHJok60oQmT8zhnUWc4SWBJI7ztPTs88C0gOsJJ
responses:
'200':
description: Returned when authentication link could be successfully generated
content:
application/json:
schema:
type: object
properties:
status:
enum: [success, error]
description: indicates that an error happened (value is success)
type: string
'403':
description: Returned when credentials (dev ID and API key) are invalid
content:
application/json:
schema:
type: object
properties:
message:
description: a detailed message describing the error
type: string
status:
type: string
enum: [success, error]
description: indicates that an error happened (value is error)
'404':
description: Returned when the user_id is not existent
content:
application/json:
schema:
type: object
properties:
message:
description: a detailed message describing the error
type: string
status:
type: string
enum: [success, error]
description: indicates that an error happened (value is error)
/auth/generateAuthToken:
post:
tags:
- Authentication
summary: Generates an authentication token for the Terra mobile SDKs
description: Creates a token to be used with initConnection() functions in the Terra mobile SDKs in order to create a user record for Apple Health or Samsung Health (or equivalent)
operationId: generate-authentication-token
parameters:
- name: dev-id
in: header
description: your developer ID
required: true
schema:
type: string
example: testingTerra
- name: x-api-key
in: header
description: your API key
required: true
schema:
type: string
example: OtHJok60oQmT8zhnUWc4SWBJI7ztPTs88C0gOsJJ
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: |-
{
"status": "success",
"token": "250c68b9c21b78e40e7a3285a2d538d3bc24aabd3b4c76a782fb0a571ca4501d",
"expires_in": 180
}
schema:
type: object
properties:
status:
type: string
example: success
token:
type: string
example: 250c68b9c21b78e40e7a3285a2d538d3bc24aabd3b4c76a782fb0a571ca4501d
expires_in:
type: integer
example: 180
default: 0
'404':
description: '404'
content:
application/json:
examples:
Result:
value: |-
{
"status": "error",
"message": "Invalid dev-id was provided"
}
schema:
type: object
properties:
status:
type: string
example: error
message:
type: string
example: Invalid dev-id was provided
deprecated: false
/activity:
get:
summary: Retrieve activity data for a given user ID
description: Fetches completed workout sessions, with a defined start and end time and activity type (e.g. running, cycling, etc.)
tags:
- Data retrieval
operationId: GetActivity
parameters:
- name: user_id
in: query
description: user ID to query data for
schema:
type: string
required: true
- name: start_date
in: query
description: start date of data to query for - either ISO8601 date or unix
timestamp
schema:
oneOf:
- type: integer
- type: string
format: date
required: true
- name: end_date
in: query
description: end date of data to query for - either ISO8601 date or unix timestamp
schema:
oneOf:
- type: integer
- type: string
format: date
required: false
- name: to_webhook
in: query
description: boolean flag specifying whether to send the data retrieved to
the webhook, or in the response
schema:
type: boolean
required: false
- name: with_samples
in: query
description: boolean flag specifying whether to include detailed samples in
the returned payload
schema:
type: boolean
required: false
- name: dev-id
in: header
description: your developer ID
required: true
schema:
type: string
example: testingTerra
- name: x-api-key
in: header
description: your API key
required: true
schema:
type: string
example: OtHJok60oQmT8zhnUWc4SWBJI7ztPTs88C0gOsJJ
responses:
'200':
description: Returned upon successful data request
content:
application/json:
schema:
oneOf:
- type: object
properties:
user:
$ref: '#/components/schemas/User'
data:
type: array
items:
$ref: '#/components/schemas/Activity'
type:
type: string
nullable: true
- $ref: '#/components/schemas/NoDataReturned'
- $ref: '#/components/schemas/DataSentToWebhook'
- $ref: '#/components/schemas/RequestProcessing'
- $ref: '#/components/schemas/RateLimitRequestProcessing'
- $ref: '#/components/schemas/LargeRequestProcessingResponse'
'400':
description: Returned when one or more parameters is malformed - an appropriate
error message will be returned
content:
application/json:
schema:
type: object
properties:
message:
description: a detailed message describing the error
type: string
status:
type: string
enum: [success, error]
description: indicates that an error happened (value is error)
'401':
description: Returned when authorization with a data provider has failed
content:
application/json:
schema:
type: object
properties:
message:
description: a detailed message describing the error
type: string
status:
type: string
enum: [success, error]
description: indicates that an error happened (value is error)
'403':
description: Returned when credentials (dev ID and API key) are invalid
content:
application/json:
schema:
type: object
properties:
message:
description: a detailed message describing the error
type: string
status:
enum: [success, error]
type: string
description: indicates that an error happened (value is error)
'404':
description: Returned when a parameter does not exist on Terra's end (e.g.
user_id)
content:
application/json:
schema:
type: object
properties:
message:
description: a detailed message describing the error
type: string
status:
type: string
enum: [success, error]
description: indicates that an error happened (value is error)
post:
tags:
- Data writing
operationId: PostActivity
description: Used to post activity data to a provider. Available for Wahoo
parameters:
- name: dev-id
in: header
description: your developer ID
required: true
schema:
type: string
example: testingTerra
- name: x-api-key
in: header
description: your API key
required: true
schema:
type: string
example: OtHJok60oQmT8zhnUWc4SWBJI7ztPTs88C0gOsJJ
requestBody:
content:
application/json:
schema:
type: object
properties:
data:
description: List of user-tracked workouts to post to data provider
type: array
items:
$ref: '#/components/schemas/Activity'
required:
- data
required: true
responses:
'201':
description: Returned when activity was successfully created on the provider
content:
application/json:
schema:
type: object
properties:
user:
$ref: '#/components/schemas/User'
log_ids:
description: List of identifiers for the objects created, returned
in the same order they were posted. I.e. Posting [ObjectA, ObjectB]
will return [IdentifierA, IdentifierB]
type: array
items:
type: string
message:
type: string
default: Activity successfully logged
'400':
description: Returned when one or more parameters is malformed - an appropriate
error message will be returned
content:
application/json:
schema:
type: object
properties:
message:
description: a detailed message describing the error
type: string
status:
type: string
enum: [success, error]
description: indicates that an error happened (value is error)
'403':
description: Returned when credentials (dev ID and API key) are invalid
content:
application/json:
schema:
type: object
properties:
message:
description: a detailed message describing the error
type: string
status:
type: string
enum: [success, error]
description: indicates that an error happened (value is error)
'404':
description: Returned when a parameter does not exist on Terra's end (e.g.
user_id)
content:
application/json:
schema:
type: object
properties:
message:
description: a detailed message describing the error
type: string
status:
type: string
enum: [success, error]
description: indicates that an error happened (value is error)
/athlete:
get:
summary: Retrieve user profile info for a given user ID
description: Fetches relevant profile info such as first & last name, birth date etc. for a given user ID
tags:
- Data retrieval
operationId: GetAthlete
parameters:
- name: user_id
in: query
description: user ID to query data for
schema:
type: string
required: true
- name: to_webhook
in: query
description: boolean flag specifying whether to send the data retrieved to
the webhook, or in the response
schema:
type: boolean
required: false
- name: dev-id
in: header
description: your developer ID
required: true
schema:
type: string
example: testingTerra
- name: x-api-key
in: header
description: your API key
required: true
schema:
type: string
example: OtHJok60oQmT8zhnUWc4SWBJI7ztPTs88C0gOsJJ
responses:
'200':
description: Returned upon successful data request
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/AthleteCollection'
- $ref: '#/components/schemas/NoDataReturned'
- $ref: '#/components/schemas/DataSentToWebhook'
'400':
description: Returned when one or more parameters is malformed - an appropriate
error message will be returned
content:
application/json:
schema:
type: object
properties:
message:
description: a detailed message describing the error
type: string
status:
enum: [success, error]
type: string
description: indicates that an error happened (value is error)
'401':
description: Returned when authorization with a data provider has failed
content:
application/json:
schema:
type: object
properties:
message:
description: a detailed message describing the error
type: string
status:
type: string
enum: [success, error]
description: indicates that an error happened (value is error)
'403':
description: Returned when credentials (dev ID and API key) are invalid
content:
application/json:
schema:
type: object
properties:
message:
description: a detailed message describing the error
type: string
status:
type: string
enum: [success, error]
description: indicates that an error happened (value is error)
'404':
description: Returned when a parameter does not exist on Terra's end (e.g.
user_id)
content:
application/json:
schema:
type: object
properties:
message:
description: a detailed message describing the error
type: string
status:
type: string
enum: [success, error]
description: indicates that an error happened (value is error)
/body:
get:
summary: Retrieve body metrics for a given user ID
description: Fetches body metrics such as weight, height, body fat percentage etc. for a given user ID
tags:
- Data retrieval
operationId: GetBody
parameters:
- name: user_id
in: query
description: user ID to query data for
schema:
type: string
required: true
- name: start_date
in: query
description: start date of data to query for - either ISO8601 date or unix
timestamp
schema:
oneOf:
- type: integer
- type: string
format: date
required: true
- name: end_date
in: query
description: end date of data to query for - either ISO8601 date or unix timestamp
schema:
oneOf:
- type: integer
- type: string
format: date
required: false
- name: to_webhook
in: query
description: boolean flag specifying whether to send the data retrieved to
the webhook, or in the response
schema:
type: boolean
required: false
- name: with_samples
in: query
description: boolean flag specifying whether to include detailed samples in
the returned payload
schema:
type: boolean
required: false
- name: dev-id
in: header
description: your developer ID
required: true
schema:
type: string
example: testingTerra
- name: x-api-key
in: header
description: your API key
required: true
schema:
type: string
example: OtHJok60oQmT8zhnUWc4SWBJI7ztPTs88C0gOsJJ
responses:
'200':
description: Returned upon successful data request
content:
application/json:
schema:
oneOf:
- type: object
properties:
user:
$ref: '#/components/schemas/User'
data:
type: array
items:
$ref: '#/components/schemas/Body'
type:
type: string
nullable: true
- $ref: '#/components/schemas/NoDataReturned'
- $ref: '#/components/schemas/DataSentToWebhook'
- $ref: '#/components/schemas/RequestProcessing'
- $ref: '#/components/schemas/RateLimitRequestProcessing'
- $ref: '#/components/schemas/LargeRequestProcessingResponse'
'400':
description: Returned when one or more parameters is malformed - an appropriate
error message will be returned
content:
application/json:
schema:
type: object
properties:
message:
description: a detailed message describing the error
type: string
status:
type: string
enum: [success, error]
description: indicates that an error happened (value is error)
'401':
description: Returned when authorization with a data provider has failed
content:
application/json:
schema:
type: object
properties:
message:
description: a detailed message describing the error
type: string
status:
type: string
enum: [success, error]
description: indicates that an error happened (value is error)
'403':
description: Returned when credentials (dev ID and API key) are invalid
content:
application/json:
schema:
type: object
properties:
message:
description: a detailed message describing the error
type: string
status:
type: string
enum: [success, error]
description: indicates that an error happened (value is error)
'404':
description: Returned when a parameter does not exist on Terra's end (e.g.
user_id)
content:
application/json:
schema:
type: object
properties:
message:
description: a detailed message describing the error
type: string
status:
type: string
enum: [success, error]
description: indicates that an error happened (value is error)
post:
tags:
- Data writing
operationId: PostBody
description: Used to post body data to a provider. Available for Google Fit
parameters:
- name: dev-id
in: header
description: your developer ID
required: true
schema:
type: string
example: testingTerra
- name: x-api-key
in: header
description: your API key
required: true
schema:
type: string
example: OtHJok60oQmT8zhnUWc4SWBJI7ztPTs88C0gOsJJ
requestBody:
content:
application/json:
schema:
type: object
properties:
data:
description: Body measurement metrics to post to data provider
type: array
items:
$ref: '#/components/schemas/Body'
required:
- data
required: true
responses:
'201':
description: Returned when activity was successfully created on the provider
content:
application/json:
schema:
type: object
properties:
user:
$ref: '#/components/schemas/User'
log_ids:
description: List of identifiers for the objects created, returned
in the same order they were posted. I.e. Posting [ObjectA, ObjectB]
will return [IdentifierA, IdentifierB]
type: array
items:
type: string
message:
type: string
default: Body data successfully logged
'400':
description: Returned when one or more parameters is malformed - an appropriate
error message will be returned
content:
application/json:
schema:
type: object
properties:
message:
description: a detailed message describing the error
type: string
status:
type: string
enum: [success, error]
description: indicates that an error happened (value is error)
'403':
description: Returned when credentials (dev ID and API key) are invalid
content:
application/json:
schema:
type: object
properties:
message:
description: a detailed message describing the error
type: string
status:
type: string
enum: [success, error]
description: indicates that an error happened (value is error)
'404':
description: Returned when a parameter does not exist on Terra's end (e.g.
user_id)
content:
application/json:
schema:
type: object
properties:
message:
description: a detailed message describing the error
type: string
status:
type: string
enum: [success, error]
description: indicates that an error happened (value is error)
delete:
tags:
- Data writing
operationId: DeleteBody
description: Used to delete Body metrics the user has registered on their account
parameters:
- name: user_id
in: query
description: user ID to query data for
schema:
type: string
required: true
- name: dev-id
in: header
description: your developer ID
required: true
schema:
type: string
example: testingTerra
- name: x-api-key
in: header
description: your API key
required: true
schema:
type: string
example: OtHJok60oQmT8zhnUWc4SWBJI7ztPTs88C0gOsJJ
requestBody:
content:
application/json:
schema:
type: object
properties:
log_ids:
type: array
description: List of identifiers for body metrics entries to be
deleted
items:
type: string
required:
- data
required: true
responses:
'200':
description: Returned when all records were deleted successfully
content:
application/json:
schema:
type: object
properties:
user:
$ref: '#/components/schemas/User'
processed_data:
type: array
items:
type: object
properties:
id:
type: string
description: Identifier of the body metric entries whose
deletion was attempted
response_code:
type: integer
description: Response code from the provider when attempting
to delete the body metric entries
'207':
description: Returned when multiple status codes were obtained from attempting
to delete the requested records
content:
application/json:
schema:
type: object
properties:
user:
$ref: '#/components/schemas/User'
processed_data:
type: array
items: