-
Notifications
You must be signed in to change notification settings - Fork 0
/
test.json
6419 lines (6406 loc) · 202 KB
/
test.json
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
{
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"schemes": [
"https"
],
"swagger": "2.0",
"info": {
"description": "# ** Introducing the new Samsara Open API **\n\nAt Samsara, we’re committed to delivering the best functionality to help you achieve your business goals. We heard your feedback from our v1 API, and we're excited to provide you with the new official Samsara Open API. You can read more about this new API on our [Samsara Open API Release FAQ](https://google.com) page.\n\n If you would like to access the existing API docs, you can still do so at this link: [Samara V1 API](https://samsara.com/api-v1).\n\n*Note: This is an API preview, and not a final API spec. Samsara is making this available to outside parties to gather feedback, but we do not recommend coding directly against this API just yet. Samsara reserves the right to make breaking changes until the API’s full release.* \n\n# Overview\n\nSamsara provides API endpoints for interacting with Samsara Cloud, so that you can build powerful applications and custom solutions with sensor data. Samsara has endpoints available to track and analyze sensors, vehicles, and entire fleets.\n\nThe Samsara Cloud API is a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer) accessed by an [HTTP](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol) client such as wget or curl, or HTTP libraries of most modern programming languages including python, ruby, java. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We allow you to interact securely with our API from a client-side web application (though you should never expose your secret API key). [JSON](http://www.json.org/) is returned by all API responses, including errors. If you’re familiar with what you can build with a REST API, the following API reference guide will be your go-to resource.\n\nAPI access to the Samsara cloud is available to all Samsara administrators. To start developing with Samsara APIs you will need to [obtain your API keys](#section/Authentication) to authenticate your API requests.\n\nIf you have any questions you can reach out to us on [[email protected]](mailto:[email protected])\n\n# Endpoints\n\nAll our APIs can be accessed through HTTP requests to URLs like:\n\n```curl\nhttps://api.samsara.com/\u003cendpoint\u003e\n```\n\nAll our APIs are [versioned](#section/Versioning). If we intend to make breaking changes to an API which either changes the response format or request parameter, we will increment the version.\n\n# Authentication\n\nTo authenticate your API request you will need to include your secret token. You can manage your API tokens in the [Dashboard](https://cloud.samsara.com). They are visible under `Settings-\u003eOrganization-\u003eAPI Tokens`.\n\nYour API tokens carry many privileges, so be sure to keep them secure. Do not share your secret API tokens in publicly accessible areas such as GitHub, client-side code, and so on. Authentication to the API is performed via Bearer Token in the HTTP Authorization header. Provide your API token as the access_token value in an Authorization: Bearer header. You do not need to provide a password. \n\n```curl Authorization: Bearer {access_token}```\n\n All API requests must be made over [HTTPS](https://en.wikipedia.org/wiki/HTTPS). Calls made over plain HTTP or without authentication will fail. \n\n# Versioning\n\nAll our APIs are versioned. Our current API version is v1 and we are continuously working on improving it further and providing additional endpoints. If we intend to make breaking changes in a backwards-incompatible way, we release a new dated version to your API. Thus, you can use our current API version worry free. For a detailed guide on how to upgrade your API token, please check out this [Knowledge Base article](https://kb.samsara.com/hc/en-us/articles/360026132972-Upgrading-API-Tokens).\n\n# FAQs\n\nCheck out our [responses to FAQs here](https://kb.samsara.com/hc/en-us/sections/360000538054-APIs). Don’t see an answer to your question? Reach out to us on [[email protected]](mailto:[email protected]).",
"title": "Samsara API",
"version": "1.0.0"
},
"host": "api.samsara.com",
"paths": {
"/addresses": {
"get": {
"description": "Returns a list of all addresses in an organization",
"tags": [
"Addresses"
],
"summary": "List all addresses",
"operationId": "getAddresses",
"parameters": [
{
"maximum": 512,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 512,
"description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.",
"name": "limit",
"in": "query"
},
{
"type": "string",
"description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.",
"name": "after",
"in": "query"
}
],
"responses": {
"200": {
"description": "List of all addresses in the organization",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Address"
}
},
"pagination": {
"$ref": "#/definitions/paginationResponse"
}
}
}
},
"default": {
"description": "Error response.",
"schema": {
"$ref": "#/definitions/standardErrorResponse"
}
}
}
},
"post": {
"description": "Creates a new address in the organization",
"tags": [
"Addresses"
],
"summary": "Create an address",
"operationId": "createAddress",
"parameters": [
{
"description": "The address to create.",
"name": "address",
"in": "body",
"schema": {
"$ref": "#/definitions/AddressCreate"
}
}
],
"responses": {
"200": {
"description": "Newly created address object with ID",
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Address"
}
}
}
},
"default": {
"description": "Error response.",
"schema": {
"$ref": "#/definitions/standardErrorResponse"
}
}
}
}
},
"/documents": {
"get": {
"tags": ["Documents"],
"description": "Get all documents",
"summary": "Get all documents",
"operationId": "getDocuments",
"parameters": [
{
"maximum": 512,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 512,
"description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.",
"name": "limit",
"in": "query"
},
{
"type": "string",
"description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.",
"name": "after",
"in": "query"
},
{
"type": "string",
"format": "string",
"description": "Beginning of the time range, specified in RFC 3339 time.",
"name": "startTime",
"in": "query"
},
{
"type": "string",
"format": "string",
"description": "End of the time range, specified in RFC 3339 time.",
"name": "endTime",
"in": "query"
},
{
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"description": "A comma-separated list of vehicle IDs.",
"name": "vehicleIds",
"in": "query"
}
],
"responses": {
"200": {
"description": "List of all documents",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Document"
}
},
"pagination": {
"$ref": "#/definitions/paginationResponse"
}
}
}
}
}
},
"post": {
"tags": ["Documents"],
"description": "Create a document.",
"operationId": "createDocument",
"parameters": [],
"responses": {
"200": {
"description": "Newly created document object with ID.",
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Document"
}
}
}
}
}
}
},
"/addresses/{id}": {
"get": {
"description": "Returns a specific address.",
"tags": [
"Addresses"
],
"summary": "Get information about a specific address",
"operationId": "getAddressById",
"responses": {
"200": {
"description": "Newly created address object with ID",
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Address"
}
}
}
},
"default": {
"description": "Unexpected error.",
"schema": {
"$ref": "#/definitions/standardErrorResponse"
}
}
}
},
"delete": {
"description": "Delete a specific address.",
"tags": [
"Addresses"
],
"summary": "Delete a specific address",
"operationId": "deleteAddressById",
"responses": {
"204": {
"description": "Empty success body"
},
"default": {
"description": "Error response.",
"schema": {
"$ref": "#/definitions/standardErrorResponse"
}
}
}
},
"patch": {
"description": "Update a specific address.",
"tags": [
"Addresses"
],
"summary": "Update information about a specific address",
"operationId": "updateAddressById",
"parameters": [
{
"description": "The address fields to update.",
"name": "address",
"in": "body",
"schema": {
"$ref": "#/definitions/AddressPatch"
}
}
],
"responses": {
"200": {
"description": "Newly created address object with ID",
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Address"
}
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#/definitions/standardErrorResponse"
}
}
}
},
"parameters": [
{
"type": "string",
"description": "Unique Samsara ID for the address",
"name": "id",
"in": "path",
"required": true
}
]
},
"/contacts": {
"get": {
"description": "Returns a list of all contacts in an organization.",
"tags": [
"Contacts"
],
"summary": "List all contacts",
"operationId": "getContacts",
"parameters": [
{
"maximum": 512,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 512,
"description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.",
"name": "limit",
"in": "query"
},
{
"type": "string",
"description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.",
"name": "after",
"in": "query"
}
],
"responses": {
"200": {
"description": "List of all contacts",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Contact"
}
},
"pagination": {
"$ref": "#/definitions/paginationResponse"
}
}
}
},
"default": {
"description": "Unexpected error.",
"schema": {
"$ref": "#/definitions/standardErrorResponse"
}
}
}
},
"post": {
"description": "Add a contact to the organization",
"tags": [
"Contacts"
],
"summary": "Add a contact to the organization",
"operationId": "createContact",
"parameters": [
{
"description": "Add a contact.",
"name": "contact",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ContactInput"
}
}
],
"responses": {
"200": {
"description": "Contact was successfully added.",
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Contact"
}
}
}
},
"default": {
"description": "Unexpected error.",
"schema": {
"$ref": "#/definitions/standardErrorResponse"
}
}
}
}
},
"/contacts/{id}": {
"get": {
"description": "Get a specific contact's information.",
"tags": [
"Contacts"
],
"summary": "Get a contact's information",
"operationId": "getContactById",
"responses": {
"200": {
"description": "Returns the specified contact.",
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Contact"
}
}
}
},
"default": {
"description": "Unexpected error.",
"schema": {
"$ref": "#/definitions/standardErrorResponse"
}
}
}
},
"delete": {
"description": "Delete the given contact.",
"tags": [
"Contacts"
],
"summary": "Delete a contact",
"operationId": "deleteContactById",
"responses": {
"204": {
"description": "Returns an empty success response.",
"schema": {}
},
"default": {
"description": "Unexpected error.",
"schema": {
"$ref": "#/definitions/standardErrorResponse"
}
}
}
},
"patch": {
"description": "Update a specific contact's information.",
"tags": [
"Contacts"
],
"summary": "Update a contact's information",
"operationId": "updateContactById",
"parameters": [
{
"description": "Updates to the contact.",
"name": "contact",
"in": "body",
"schema": {
"$ref": "#/definitions/ContactInput"
}
}
],
"responses": {
"200": {
"description": "Updated contact object with given ID.",
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Contact"
}
}
}
},
"default": {
"description": "Unexpected error.",
"schema": {
"$ref": "#/definitions/standardErrorResponse"
}
}
}
},
"parameters": [
{
"type": "string",
"description": "Unique identifier for the contact.",
"name": "id",
"in": "path",
"required": true
}
]
},
"/fleet/drivers": {
"get": {
"description": "Get all drivers in organization.",
"tags": [
"Drivers"
],
"summary": "List all drivers",
"operationId": "getDrivers",
"parameters": [
{
"type": "boolean",
"description": "Filter only for inactive drivers. This parameter will default to false if not provided.",
"name": "isInactive",
"in": "query"
},
{
"maximum": 512,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 512,
"description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.",
"name": "limit",
"in": "query"
},
{
"type": "string",
"description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.",
"name": "after",
"in": "query"
},
{
"type": "string",
"description": "A comma-separated list of tag IDs.",
"name": "tagIds",
"in": "query"
}
],
"responses": {
"200": {
"description": "List of all driver objects.",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Driver"
}
},
"pagination": {
"$ref": "#/definitions/paginationResponse"
}
}
}
},
"default": {
"description": "Unexpected error.",
"schema": {
"$ref": "#/definitions/standardErrorResponse"
}
}
}
},
"post": {
"description": "Add a driver to the organization.",
"tags": [
"Drivers"
],
"summary": "Create a driver",
"operationId": "createDriver",
"parameters": [
{
"description": "The driver to create.",
"name": "driver",
"in": "body",
"schema": {
"$ref": "#/definitions/DriverCreate"
}
}
],
"responses": {
"200": {
"description": "Newly created driver object, with Samsara-generated ID.",
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Driver"
}
}
}
},
"default": {
"description": "Unexpected error.",
"schema": {
"$ref": "#/definitions/standardErrorResponse"
}
}
}
}
},
"/fleet/drivers/safety-scores": {
"get": {
"description": "Fetch safety scores for all drivers in the organization in a given time period.",
"tags": [
"Safety"
],
"summary": "Fetch all safety scores by driver",
"operationId": "getOrgDriverSafetyScores",
"parameters": [
{
"type": "string",
"format": "string",
"description": "Beginning of the time range, specified in RFC 3339 time.",
"name": "startTime",
"in": "query",
"required": true
},
{
"type": "string",
"format": "string",
"description": "End of the time range, specified in RFC 3339 time.",
"name": "endTime",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "Safety scores for all vehicles in the organization",
"schema": {
"$ref": "#/definitions/OrgSafetyScoresResponse"
}
},
"default": {
"description": "Unexpected error.",
"schema": {
"$ref": "#/definitions/standardErrorResponse"
}
}
}
}
},
"/fleet/drivers/{id}": {
"get": {
"description": "Get information about a driver.",
"tags": [
"Drivers"
],
"summary": "Get a driver",
"operationId": "getDriverById",
"responses": {
"200": {
"description": "Returns the specified driver.",
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Driver"
}
}
}
},
"default": {
"description": "Unexpected error.",
"schema": {
"$ref": "#/definitions/standardErrorResponse"
}
}
}
},
"patch": {
"description": "Update a specific driver's information. This can also be used to activate or de-activate a given driver",
"tags": [
"Drivers"
],
"summary": "Update driver properties",
"operationId": "updateDriverById",
"parameters": [
{
"description": "Updates to the driver properties.",
"name": "driver",
"in": "body",
"schema": {
"$ref": "#/definitions/DriverUpdate"
}
}
],
"responses": {
"200": {
"description": "Updated driver object, with ID.",
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/Driver"
}
}
}
},
"default": {
"description": "Unexpected error.",
"schema": {
"$ref": "#/definitions/standardErrorResponse"
}
}
}
},
"delete": {
"description": "Samsara does not allow the deletion of drivers today. If you would like to delete a driver, please use the PATCH drivers endpoint in order to inactivate a driver.",
"tags": [
"Drivers"
],
"summary": "Delete driver",
"responses": {
"default": {
"description": "Unexpected error.",
"schema": {
"$ref": "#/definitions/standardErrorResponse"
}
}
}
},
"parameters": [
{
"type": "string",
"description": "ID of the driver. This can either be the Samsara-specified ID, or an external ID.",
"name": "id",
"in": "path",
"required": true
}
]
},
"/fleet/equipment/locations": {
"get": {
"description": "This endpoint allows you to both fetch historical locations for all equipment as well as a feed of all new equipment locations.\n\nIf you wish to just fetch historical location data, you can pass in a startTime and endTime range. This will return all location data points ingested by Samsara during the given time range. Note that there may be certain data points within the response with a timestamp before the startTime, in the case that there is a connectivity lag between the asset and the server.",
"tags": [
"Equipment"
],
"summary": "Fetch locations for all equipment",
"operationId": "getEquipmentLocationsHistory",
"parameters": [
{
"type": "string",
"description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.",
"name": "after",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).",
"name": "startTime",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).",
"name": "endTime",
"in": "query"
},
{
"type": "string",
"description": "A comma-separated list of tag IDs.",
"name": "tagIds",
"in": "query"
},
{
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"description": "A comma-separated list of equipment IDs.",
"name": "equipmentIds",
"in": "query"
}
],
"responses": {
"200": {
"description": "List of all equipment location objects and pagination parameters",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/EquipmentLocationsResponse"
}
},
"pagination": {
"type": "object",
"allOf": [
{
"$ref": "#/definitions/EquipmentTimeSeriesPaginationResponse"
}
]
}
}
}
},
"default": {
"description": "Unexpected error.",
"schema": {
"$ref": "#/definitions/standardErrorResponse"
}
}
}
}
},
"/fleet/equipment/stats": {
"get": {
"description": "This endpoint allows you to both fetch historical stats for all equipment as well as a feed of all new equipment stats.\n\nIf you wish to just fetch historical stat data, you can pass in a startTime and endTime range. This will return all stat data points ingested by Samsara during the given time range. Note that there may be certain data points within the response with a timestamp before the startTime, in the case that there is a connectivity lag between the asset and the server.",
"tags": [
"Equipment"
],
"summary": "Fetch stats for all equipment",
"operationId": "getEquipmentStatsHistory",
"parameters": [
{
"type": "string",
"description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.",
"name": "after",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).",
"name": "startTime",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).",
"name": "endTime",
"in": "query"
},
{
"type": "string",
"description": "A comma-separated list of tag IDs.",
"name": "tagIds",
"in": "query"
},
{
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"description": "A comma-separated list of equipment IDs.",
"name": "equipmentIds",
"in": "query"
}
],
"responses": {
"200": {
"description": "List of all equipment stat objects and pagination parameters",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/EquipmentStatsResponse"
}
},
"pagination": {
"type": "object",
"allOf": [
{
"$ref": "#/definitions/EquipmentTimeSeriesPaginationResponse"
}
]
}
}
}
},
"default": {
"description": "Unexpected error.",
"schema": {
"$ref": "#/definitions/standardErrorResponse"
}
}
}
}
},
"/fleet/vehicles": {
"get": {
"description": "Returns a list of all vehicles in an organization, ordered by vehicle ID.",
"tags": [
"Vehicles"
],
"summary": "List all vehicles",
"operationId": "listVehiclesKondo",
"parameters": [
{
"maximum": 512,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 512,
"description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.",
"name": "limit",
"in": "query"
},
{
"type": "string",
"description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.",
"name": "after",
"in": "query"
},
{
"type": "string",
"description": "A comma-separated list of tag IDs.",
"name": "tagIds",
"in": "query"
}
],
"responses": {
"200": {
"description": "List of all vehicle objects, and pagination parameters.",
"schema": {
"$ref": "#/definitions/VehicleListResponse"
}
},
"default": {
"description": "Unexpected error.",
"schema": {
"$ref": "#/definitions/standardErrorResponse"
}
}
}
}
},
"/fleet/vehicles/harsh-events": {
"get": {
"description": "Fetch all harsh events for the organization in a given time period.",
"tags": [
"Safety"
],
"summary": "Fetch all harsh events",
"operationId": "getOrgHarshEvents",
"parameters": [
{
"type": "string",
"format": "string",
"description": "Beginning of the time range, specified in RFC 3339 time.",
"name": "startTime",
"in": "query",
"required": true
},
{
"type": "string",
"format": "string",
"description": "End of the time range, specified in RFC 3339 time.",
"name": "endTime",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "Harsh events for the organization",
"schema": {
"$ref": "#/definitions/OrgHarshEventsKondoResponse"
}
},
"default": {
"description": "Unexpected error.",
"schema": {
"$ref": "#/definitions/standardErrorResponse"
}
}
}
}
},
"/fleet/vehicles/locations": {
"get": {
"description": "This endpoint allows you to both fetch historical locations for a vehicle, as well as a feed of all new vehicle locations.\n\nIf you wish to just fetch the historical location data for a vehicle, you can pass in a `startTime` and `endTime` range. This will return all known locations for a vehicle during a given time range.\n\nIf an `endTime` is not provided, then this will provide a continuous feed of all vehicle locations. In order to follow the feed, you can follow the pagination `endCursor` cursor continuously. If there is not yet a `hasNextPage=true` for the feed follow, then we recommend you wait and retry in 5 seconds.",
"tags": [
"Vehicles"
],
"summary": "Fetch vehicle locations",
"operationId": "getVehicleLocationsHistory",
"parameters": [
{
"type": "string",
"description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.",
"name": "after",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).",
"name": "startTime",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).",
"name": "endTime",
"in": "query"
},
{
"type": "string",
"description": "A comma-separated list of tag IDs.",
"name": "tagIds",
"in": "query"
},
{
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"description": "A comma-separated list of vehicle IDs.",
"name": "vehicleIds",
"in": "query"
}
],
"responses": {
"200": {
"description": "List of all locations for the specified vehicles and time range.",
"schema": {