forked from sodadata/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.json
1431 lines (1431 loc) · 58.6 KB
/
openapi.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
{
"openapi": "3.0.2",
"info": {
"title": "Soda Cloud Reporting API",
"description": "\nThis API enables you to query data from your Soda Cloud account. Use the data to build reporting dashboards that\ncommunicate how users in your organization are adopting and making use of Soda Cloud.\n\nAuthentication\n-----\nThe API supports both `HTTPBasic` authentication and `TokenAuth` authentication. Except for the `/get_token` endpoint,\nwhich only supports HTTP Basic authentication.\n\n- `HTTPBasic` authentication requires you to provide a username and password via headers. Each endpoint \"Try It\" section\nwill show you exactly how to do that.\n\n- `TokenAuth` requires that you obtain a Soda token from the `/get_token` endpoint using your username and password\nin accordance with the HTTPBasic Authentication framework. This token has an expiration of 30 minutes. The `/get_token`\nendpoint makes this clear to you (see endpoint documentation below). You can then use this token to authenticate with\nany of the other endpoints.\n\n- `ApiKeyId` and `ApiKeySecret` allow you to use API keys generated in your Cloud Profile. Use this method if\nyour organization is using Single Sign-On (SSO). Provide your API Key Id and API Key Secret in the\n`API_KEY_ID` and `API_KEY_SECRET` headers, respectively. If you do not know how to generate your API Key and Secret\npair follow the\n[Connect Soda Core to Soda Cloud](https://docs.soda.io/soda-core/configure.html#connect-soda-core-to-soda-cloud)\ndocumentation.\n\n\nTesting\n-----\nYou can test the API using the following methods.\n* Test the API endpoints within the documentation. Provide the authentication credentials, when required,\nin the **Auth** toggle in the testing window embedded in each endpoint's documentation.\n* Test the API using an API testing platform such as Postman. Provide the `Basic Auth` authentication\ncredentials in your chosen testing platform.\n* Test the API using an HTTP request library such as `httpx` in Python, an example of which follows.\n```python\nimport httpx\nrequest_result = httpx.post(\"<endpoint_URL>\", auth=(\"username\", \"password\"))\n```\n",
"version": "0.3.2"
},
"servers": [
{ "url": "https://reporting.cloud.soda.io", "description": "Soda Cloud" }
],
"paths": {
"/ping": {
"get": {
"tags": ["Status"],
"summary": "Soda can is open",
"description": "Ping this endpoint to test whether the Reporting API is live.\nReturns the sound of a Soda can opening along with a 200.",
"operationId": "soda_can_is_open_ping_get",
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
}
}
}
},
"/v0/get_token": {
"get": {
"tags": ["Authentication"],
"summary": "Get token",
"description": "This enpoint allows you to obtain a limited duration API token to use in any of the other endpoints.\n\nMake a query to this endpoint according to the `HTTPBasic` authentication headers\n(see \"Live testing\" section on the right).\n\nThe expiration limit of the token is given to you in the response.\n\nReturns\n-------\nAn object of type `GetTokenResult`.\n\nFind details about the response objects in the **Schemas** section or by unfurling the response\ndetails.",
"operationId": "get_token_v0_get_token_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/GetTokenResult" }
}
}
}
},
"security": [{ "HTTPBasic": [] }]
}
},
"/v0/audit_trail": {
"get": {
"tags": ["Auditing"],
"summary": "Audit Trail",
"description": "This endpoint returns a list of audit trail events for the authenticated user's organization.\n\nTo obtain data from this endpoint, the authenticated user must be an **organization admin**\nand the data returned is equivalent to the what an Organization admin would be able to get from\nthe Soda Cloud UI under \"Organization Settings > Audit Trail\".\n\nUsage\n-----\nUse this endpoint to capture audit trail events for security and usage monitoring purposes.\n\nReturns\n-------\nAn object of type `AuditTrailResult` containing an array of `AuditTrailData`.\n\nFind details about the response objects in the **Schemas** section or by unfurling the response\ndetails.",
"operationId": "audit_trail_v0_audit_trail_get",
"parameters": [
{
"required": false,
"schema": {
"title": "From Datetime",
"type": "string",
"format": "date-time",
"default": "2022-09-09T15:24:47.333197"
},
"name": "from_datetime",
"in": "query"
},
{
"required": false,
"schema": {
"title": "To Datetime",
"type": "string",
"format": "date-time",
"default": "2022-10-10T15:24:47.333229"
},
"name": "to_datetime",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/AuditTrailResult" }
}
}
},
"202": {
"description": "Successful request but no data was returned",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/NoContentError" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
},
"security": [
{ "HTTPBasic": [] },
{ "SodaBackendToken": [] },
{ "APIKeyCookie": [] },
{ "ApiKeyId": [] },
{ "APIKeySecret": [] }
]
}
},
"/v0/adoption/sign_ups": {
"post": {
"tags": ["Tool Adoption"],
"summary": "Sign-ups",
"description": "This endpoint returns sign-up events for the authenticated user's organization.\n\nTo avoid incomplete reporting, Soda currently updates this data once per day and does not include\nthe current date (UTC).\n\n**NOTE:** The event tracking solution does not currently track users who signed up via SSO.\n\nUsage\n-----\nUse this endpoint to build reports about Soda's adoption across your organization.\n\nReturns\n-------\nAn object of type `SignUpsResult` containing an array of `SignUpData`.\n\nFind details about the response objects in the **Schemas** section or by unfurling the response\ndetails.",
"operationId": "sign_ups_v0_adoption_sign_ups_post",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/SignUpsResult" }
}
}
},
"202": {
"description": "Successful request but no data was returned",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/NoContentError" }
}
}
}
},
"security": [
{ "HTTPBasic": [] },
{ "SodaBackendToken": [] },
{ "APIKeyCookie": [] },
{ "ApiKeyId": [] },
{ "APIKeySecret": [] }
]
}
},
"/v0/adoption/sign_ins": {
"post": {
"tags": ["Tool Adoption"],
"summary": "Sign-ins",
"description": "This endpoint provides the number of logins for a specific user per day.\n\nTo avoid incomplete reporting, Soda currently updates this data once per day and does not include\nthe current date (UTC).\n\n**NOTE:** The event tracking solution does not currently track users who signed up via SSO.\n\nUsage\n-----\nUse this endpoint to build reports about Soda's adoption throughout your organization.\n\nReturns\n-------\nAn object of type `SignInsResult` containing an array of `SignInData`\n\nFind details about the response objects in the **Schemas** section or by unfurling the response\ndetails.",
"operationId": "sign_ins_v0_adoption_sign_ins_post",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/SignInsResult" }
}
}
},
"202": {
"description": "Successful request but no data was returned",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/NoContentError" }
}
}
}
},
"security": [
{ "HTTPBasic": [] },
{ "SodaBackendToken": [] },
{ "APIKeyCookie": [] },
{ "ApiKeyId": [] },
{ "APIKeySecret": [] }
]
}
},
"/v0/adoption/daily_account_activity": {
"post": {
"tags": ["Tool Adoption"],
"summary": "Daily account activity",
"description": "This endpoint provides a daily count of activity events for the authenticated user's organization.\n\nThe endpoint groups events into one of two groups: \"Level 0\" or \"Level 1\".\n\n**Level 0**: Activity of type **\"Read\"/\"View\"** (For example, view a dataset, view a monitor result.)\n**Level 1**: Activity of type **\"Create\"/\"Update\"** (For example, create a monitor, update a monitor configuration.)\n\nTo avoid incomplete reporting, Soda currently updates this data once per day and does not include\nthe current date (UTC).\n\nUsage\n-----\nUse this endpoint to build reports about Soda's adoption and usage throughout your organization.\n\nReturns\n-------\nAn object of type `DailyAccountActivityResult` containing an array of `DailyAccountActivityData`.\n\nFind details about the response objects in the **Schemas** section or by\nunfurling the response details.",
"operationId": "daily_account_activity_v0_adoption_daily_account_activity_post",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DailyAccountActivityResult"
}
}
}
},
"202": {
"description": "Successful request but no data was returned",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/NoContentError" }
}
}
}
},
"security": [
{ "HTTPBasic": [] },
{ "SodaBackendToken": [] },
{ "APIKeyCookie": [] },
{ "ApiKeyId": [] },
{ "APIKeySecret": [] }
]
}
},
"/v0/impact/alerts_sent": {
"post": {
"tags": ["Platform Impact"],
"summary": "Alerts sent",
"description": "This endpoint provides a daily count of alerts Soda has sent to a specific user.\n\nThe endpoint groups alerts into one of three groups corresponding to the criticality level of the alert\n(\"Info\", \"Warning\", \"Critical).\n\nTo avoid incomplete reporting, Soda currently updates this data once per day and does not include\nthe current date (UTC).\n\nUsage\n-----\nUse this endpoint to understand the number of alerts that Soda has sent to your team members.\nYou may, however, prefer using the `/test_and_results` endpoint to examine exactly which tests\nfailed.\n\nReturns\n-------\nAn object of type `DailyAlertsSentResult` containing an array of `DailyAlertsSentData`.\n\nFind details about the response objects in the **Schemas** section or by\nunfurling the response details.",
"operationId": "alerts_sent_v0_impact_alerts_sent_post",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DailyAlertsSentResult"
}
}
}
},
"202": {
"description": "Successful request but no data was returned",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/NoContentError" }
}
}
}
},
"security": [
{ "HTTPBasic": [] },
{ "SodaBackendToken": [] },
{ "APIKeyCookie": [] },
{ "ApiKeyId": [] },
{ "APIKeySecret": [] }
]
}
},
"/v0/adoption/scans_run": {
"post": {
"tags": ["Tool Adoption"],
"summary": "Scans run",
"description": "This endpoint provides a per-user daily count of scans that users run, as well as the number of test\nresults that Soda has evaluated.\n\nUsage\n-----\nUse this endpoint to report about the adoption of Soda throughout your organization.\n\nReturns\n-------\nAn object of type `DailyAlertsSentResult` containing an array of `DailyAlertsSentData`.\n\nFind details about the response objects in the **Schemas** section or by\nunfurling the response details.",
"operationId": "scans_run_v0_adoption_scans_run_post",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ScansRunResult" }
}
}
},
"202": {
"description": "Successful request but no data was returned",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/NoContentError" }
}
}
}
},
"security": [
{ "HTTPBasic": [] },
{ "SodaBackendToken": [] },
{ "APIKeyCookie": [] },
{ "ApiKeyId": [] },
{ "APIKeySecret": [] }
]
}
},
"/v0/coverage/tests": {
"post": {
"tags": ["Coverage"],
"summary": "Tests",
"description": "This endpoint provides a real-time list of all the tests that exist in your organization's account,\nas well as the datasets upon which each test depends.\n\nUsage\n-----\nUse this endpoint to enrich results from the `/datasets` or `/tests_and_results` endpoints.\n\nReturns\n-------\nAn object of type `TestsResult` containing an array of `TestsData` for each test.\n\nFind details about the response objects in the **Schemas** section or by\nunfurling the response details.",
"operationId": "tests_v0_coverage_tests_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"title": "Request Body",
"allOf": [{ "$ref": "#/components/schemas/TestsQuery" }],
"default": {}
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/TestsResult" }
}
}
},
"202": {
"description": "Successful request but no data was returned",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/NoContentError" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
},
"security": [
{ "HTTPBasic": [] },
{ "SodaBackendToken": [] },
{ "APIKeyCookie": [] },
{ "ApiKeyId": [] },
{ "APIKeySecret": [] }
]
}
},
"/v0/coverage/datasets": {
"post": {
"tags": ["Coverage"],
"summary": "Datasets",
"description": "This endpoint provides information about all the datasets that your team has connected to your organization's\nSoda Cloud account.\n\nUsage\n-----\nUse this endpoint to review the number of datasets Soda Cloud accesses, including each dataset's most recent scan\ntime and test failure counts.\n\nUse the data from this endpoint to enrich other endpoints' data such as `/dataset_health` and\n`/dataset_coverage`\n\nReturns\n-------\nAn object of type `DatasetsResult` containing an array of `DatasetsData`\n\nFind details about the response objects in the **Schemas** section or by\nunfurling the response details.",
"operationId": "datasets_v0_coverage_datasets_post",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/DatasetsResult" }
}
}
},
"202": {
"description": "Successful request but no data was returned",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/NoContentError" }
}
}
}
},
"security": [
{ "HTTPBasic": [] },
{ "SodaBackendToken": [] },
{ "APIKeyCookie": [] },
{ "ApiKeyId": [] },
{ "APIKeySecret": [] }
]
}
},
"/v0/quality/tests_and_results": {
"post": {
"tags": ["Quality"],
"summary": "Test results",
"description": "This endpoint provides a list of tests along with each test's historical evaluation results.\n\nUsage\n-----\nUse this endpoint to build reports that show the outcome of your tests over time. If you gathered high-level data\nfrom the `/dataset_health` and `/dataset_coverage` endpoints, you can use this endpoint to examine more granular\ndata about tests that apply to each dataset.\n\nBe sure to provide a single `dataset_id` per request, and use the `from_datetime` parameter to optimize performance.\nUse the `datasets` endpoint to first get a list of available datasets along with their IDs, then issue separate\nqueries one dataset at a time.\n\nKeep the number of potentially parallel queries that you make to this endpoint small as they can face rate\nlimitations or poor performance.\n\nReturns\n-------\nAn object of type `TestsAndResultsResult` containing an array of `TestsAndResultsData`\n\nFind details about the response objects in the **Schemas** section or by\nunfurling the response details.",
"operationId": "test_results_v0_quality_tests_and_results_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"title": "Request Body",
"allOf": [{ "$ref": "#/components/schemas/TestResultsQuery" }],
"default": {}
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TestsAndResultsResult"
}
}
}
},
"202": {
"description": "Successful request but no data was returned",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/NoContentError" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
},
"security": [
{ "HTTPBasic": [] },
{ "SodaBackendToken": [] },
{ "APIKeyCookie": [] },
{ "ApiKeyId": [] },
{ "APIKeySecret": [] }
]
}
},
"/v0/quality/dataset_health": {
"post": {
"tags": ["Quality"],
"summary": "Dataset health",
"description": "This endpoint provides you with a daily measure of the health of each of your datasets. Soda calculated a dataset's\nhealth based on the number of tests that pass during a scan.\n\nUsage\n-----\nUse this endpoint to get review the health of your datasets, and to see a high-level view of the more granular\ninformation that the `/tests_and_results` endpoint provides.\n\nUse this endpoint in conjunction with the `/datasets` endpoint as the latter adds information about each\ndataset.\n\nBe sure to provide a single `dataset_id` per request, and use the `from_datetime` parameter to optimize performance.\n\nUse the datasets endpoint to first get a list of available datasets along with their IDs, then issue separate\nqueries one dataset at a time.\n\nKeep the number of potentially parallel queries that you make to this endpoint small as they can face rate\nlimitations or poor performance.\n\nReturns\n-------\nAn object of type `DatasetHealthResult` containing an array of `DatasetHealthData`\n\nFind details about the response objects in the **Schemas** section or by\nunfurling the response details.",
"operationId": "dataset_health_v0_quality_dataset_health_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"title": "Request Body",
"allOf": [
{ "$ref": "#/components/schemas/DatasetHealthRequest" }
],
"default": { "output_all_dates": false }
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/DatasetHealthResult" }
}
}
},
"202": {
"description": "Successful request but no data was returned",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/NoContentError" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
},
"security": [
{ "HTTPBasic": [] },
{ "SodaBackendToken": [] },
{ "APIKeyCookie": [] },
{ "ApiKeyId": [] },
{ "APIKeySecret": [] }
]
}
},
"/v0/coverage/dataset_coverage": {
"post": {
"tags": ["Coverage"],
"summary": "Dataset coverage",
"description": "This endpoint provides a daily measure of the test coverage of your datasets.\nIt derives a `relative_coverage_score` which compares the number of tests that apply to a single dataset to\nother datasets connected to your organization's Soda Cloud account. (Refer to the `DatasetCoverageData` schema\nfor more information.)\n\nUsage\n-----\nUse this endpoint to review the relative test coverage of your datasets, and to see a high-level view of the more\ngranular information that the `/tests_and_results` endpoint provides.\n\nThis endpoint is best used in conjunction with the `/datasets` endpoint as the latter augments the level of\ninformation about each dataset.\n\nReturns\n-------\nAn object of type `DatasetCoverageResult` containing an array of `DatasetCoverageData`\n\nFind details about the response objects in the **Schemas** section or by\nunfurling the response details.",
"operationId": "dataset_coverage_v0_coverage_dataset_coverage_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"title": "Request Body",
"allOf": [
{ "$ref": "#/components/schemas/DatasetCoverageQuery" }
],
"default": { "include_deleted": false }
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatasetCoverageResult"
}
}
}
},
"202": {
"description": "Successful request but no data was returned",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/NoContentError" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
},
"security": [
{ "HTTPBasic": [] },
{ "SodaBackendToken": [] },
{ "APIKeyCookie": [] },
{ "ApiKeyId": [] },
{ "APIKeySecret": [] }
]
}
}
},
"components": {
"schemas": {
"AuditTrailData": {
"title": "AuditTrailData",
"type": "object",
"properties": {
"correlation_id": {
"title": "Correlation Id",
"type": "string",
"description": "Identifier of a given audited request. Note this column cannot be used as a primary key as it can span over multiple rows."
},
"eventTime": {
"title": "Eventtime",
"type": "string",
"description": "ISO UTC datetime at which the event happened.",
"format": "date-time"
},
"ipAddress": {
"title": "Ipaddress",
"type": "string",
"description": "IP address of the user who performed the logged action."
},
"email": {
"title": "Email",
"type": "string",
"description": "Email address of the user who performed the logged action."
},
"apiKey": {
"title": "Apikey",
"type": "string",
"description": "Obfuscated API key of the user who performed the logged action."
},
"comment": {
"title": "Comment",
"type": "string",
"description": "Explanation of the audited event."
},
"hash": {
"title": "Hash",
"type": "string",
"description": "A tamper-proof security and verification hash."
}
},
"description": "Contains audited events from the authorized user's organization."
},
"AuditTrailResult": {
"title": "AuditTrailResult",
"required": ["data"],
"type": "object",
"properties": {
"resource": {
"title": "Resource",
"type": "string",
"default": "audit_trail"
},
"data": {
"title": "Data",
"type": "array",
"items": { "$ref": "#/components/schemas/AuditTrailData" }
}
},
"description": "Array of `AuditTrailData`."
},
"DailyAccountActivityData": {
"title": "DailyAccountActivityData",
"type": "object",
"properties": {
"on_date": {
"title": "On Date",
"type": "string",
"description": "Date on which an activity for the authenticated user's organization took place.",
"format": "date"
},
"active_level_0_users": {
"title": "Active Level 0 Users",
"type": "integer",
"description": "Number of unique users who performed a Level 0 type of activity."
},
"active_level_1_users": {
"title": "Active Level 1 Users",
"type": "integer",
"description": "Number of unique users who performed a Level 1 type of activity."
},
"level_0_events": {
"title": "Level 0 Events",
"type": "integer",
"description": "Number of Level 0 events."
},
"level_1_events": {
"title": "Level 1 Events",
"type": "integer",
"description": "Number of Level 1 events."
}
},
"description": "Daily count of activity events for the authenticated user's organization.\n\nSoda groups events into two groups: \"Level 0\" or \"Level 1\".\nEvent are grouped into \"Level 0\" and \"Level 1\":\n\n - Level 0: Activity of type \"Read\"/\"View\" (For example, view a dataset, view monitor result.)\n - Level 1: Activity of type \"Create/Update\" (For example, create a monitor, update a monitor configuration)"
},
"DailyAccountActivityResult": {
"title": "DailyAccountActivityResult",
"required": ["resource", "data"],
"type": "object",
"properties": {
"resource": { "title": "Resource", "type": "string" },
"data": {
"title": "Data",
"type": "array",
"items": { "$ref": "#/components/schemas/DailyAccountActivityData" }
}
},
"description": "Array of `DailyAccountActivityData`."
},
"DailyAlertsSentData": {
"title": "DailyAlertsSentData",
"type": "object",
"properties": {
"user_email": {
"title": "User Email",
"type": "string",
"description": "Email address of the user who received an alert."
},
"on_date": {
"title": "On Date",
"type": "string",
"description": "Date on which an alert was sent.",
"format": "date"
},
"count_info_alerts": {
"title": "Count Info Alerts",
"type": "integer",
"description": "Number of Info level alerts sent to the user on the report date."
},
"count_warning_alerts": {
"title": "Count Warning Alerts",
"type": "integer",
"description": "Number of Warning level alerts sent to the user on the report date."
},
"count_critical_alerts": {
"title": "Count Critical Alerts",
"type": "integer",
"description": "Number of Critical level alerts sent to the user on the report date."
}
},
"description": "Aggregate counts of alerts sent on a specific day to a specific user, split by severity level."
},
"DailyAlertsSentResult": {
"title": "DailyAlertsSentResult",
"required": ["resource", "data"],
"type": "object",
"properties": {
"resource": { "title": "Resource", "type": "string" },
"data": {
"title": "Data",
"type": "array",
"items": { "$ref": "#/components/schemas/DailyAlertsSentData" }
}
},
"description": "Array of `DailyAlertsSentData`."
},
"DatasetCoverageDataObject": {
"title": "DatasetCoverageDataObject",
"required": ["descriptives", "dataset_info"],
"type": "object",
"properties": {
"descriptives": {
"$ref": "#/components/schemas/DatasetCoverageDescriptivesData"
},
"dataset_info": {
"title": "Dataset Info",
"type": "array",
"items": { "$ref": "#/components/schemas/DatasetInfoData" }
}
},
"description": "Array of `DatasetInfoData` and `DatasetCoverageDescriptivesData`."
},
"DatasetCoverageDescriptivesData": {
"title": "DatasetCoverageDescriptivesData",
"type": "object",
"properties": {
"median_number_of_tests": {
"title": "Median Number Of Tests",
"type": "number",
"description": "Median number of tests across all datasets in your organization.",
"default": 0.0
},
"max_number_of_tests": {
"title": "Max Number Of Tests",
"type": "number",
"description": "Maximum number of tests across all datasets in your organization.",
"default": 0.0
},
"min_number_of_tests": {
"title": "Min Number Of Tests",
"type": "number",
"description": "Minimum number of tests across all datasets in your organization.",
"default": 0.0
},
"standard_deviation_number_of_tests": {
"title": "Standard Deviation Number Of Tests",
"anyOf": [
{ "type": "number" },
{ "type": "string" },
{ "type": "integer" }
],
"description": "Standard deviation of the number of tests across all datasets in your organization.",
"default": 0.0
},
"mean_number_of_tests": {
"title": "Mean Number Of Tests",
"type": "number",
"description": "Mean number of tests across all datasets in your organization.",
"default": 0.0
}
},
"description": "Contains coverage descriptives across datasets."
},
"DatasetCoverageQuery": {
"title": "DatasetCoverageQuery",
"type": "object",
"properties": {
"dataset_id": {
"title": "Dataset Id",
"type": "string",
"description": "Dataset IDs (UUIDs from the Genie Cloud platform) to use as filter."
},
"include_deleted": {
"title": "Include Deleted",
"type": "boolean",
"description": "Whether to include deleted datasets or not from the report.",
"default": false
},
"ast_filter": {
"title": "Ast Filter",
"type": "object",
"description": "**Internal purposes only, undocumented**"
}
},
"description": "TODO"
},
"DatasetCoverageResult": {
"title": "DatasetCoverageResult",
"required": ["data"],
"type": "object",
"properties": {
"data": { "$ref": "#/components/schemas/DatasetCoverageDataObject" },
"resource": {
"title": "Resource",
"type": "string",
"default": "dataset_coverage"
}
},
"description": "Array of `DatasetInfoData` and `DatasetCoverageDescriptivesData`."
},
"DatasetHealthData": {
"title": "DatasetHealthData",
"type": "object",
"properties": {
"dataset_id": {
"title": "Dataset Id",
"type": "string",
"description": "Unique identifier for a dataset (UUID) in Soda Cloud."
},
"scan_date": {
"title": "Scan Date",
"type": "string",
"description": "Date at which any number of scans were run.",
"format": "date"
},
"critical": {
"title": "Critical",
"type": "integer",
"description": "Number of tests and monitors that failed with a Critical level alert."
},
"info": {
"title": "Info",
"type": "integer",
"description": "Number of tests and monitors that passed."
},
"warning": {
"title": "Warning",
"type": "integer",
"description": "Number of tests and monitors that failed with a Warning level alert."
},
"number_of_tests": {
"title": "Number Of Tests",
"type": "integer",
"description": "\nNumber of tests that were evaluated.\nNOTE: This does not correspond to the number of tests added to this dataset.\nFor example, if a test is not evaluated on a given date it will not be counted.\n "
},
"percentage_passing_tests": {
"title": "Percentage Passing Tests",
"type": "number",
"description": "Proportion of tests and monitors that passed."
},
"percent_change_percentage_passing_tests": {
"title": "Percent Change Percentage Passing Tests",
"type": "number",
"description": "\n Percentage change of the last data health point compared to a rolling average over the last\n 3\n "
}
},
"description": "Dataset health information containing counts of passing or failing tests (warning or critical) per scan date."
},
"DatasetHealthRequest": {
"title": "DatasetHealthRequest",
"type": "object",
"properties": {
"dataset_ids": {
"title": "Dataset Ids",
"type": "array",
"items": { "type": "string" },
"description": "List of dataset IDs (UUIDs from the Soda Cloud platform) to use as filter."
},
"from_datetime": {
"title": "From Datetime",
"type": "string",
"description": "\nISO 8601 datetime to specify the point in time from which you would like to get health historical data.\n",
"format": "date-time"
},
"ast_filter": {
"title": "Ast Filter",
"type": "object",
"description": "**Internal purposes only, undocumented"
},
"output_all_dates": {
"title": "Output All Dates",
"type": "boolean",
"description": "Set to true to get one record per report date even if no scan results are available for that day.",
"default": false
}
},
"description": "Schema for a dataset health request."
},
"DatasetHealthResult": {
"title": "DatasetHealthResult",
"required": ["resource", "data"],
"type": "object",
"properties": {
"resource": { "title": "Resource", "type": "string" },
"data": {
"title": "Data",
"type": "array",
"items": { "$ref": "#/components/schemas/DatasetHealthData" }
}
},
"description": "Array of `DatasetHealthData`."
},
"DatasetInfoData": {
"title": "DatasetInfoData",
"type": "object",
"properties": {
"dataset_id": {
"title": "Dataset Id",
"type": "string",
"description": "\nIdentifier (UUID) of the dataset in Soda Cloud. Join with the results of the `datasets` endpoint for more\ninformation.\n "
},
"number_of_tests": {
"title": "Number Of Tests",
"type": "integer",
"description": "Number of tests covering a specific dataset."
},
"relative_coverage_score": {
"title": "Relative Coverage Score",
"type": "string",
"description": "\nA score derived by comparing the number of tests that apply to a single dataset to the number of tests\nthat apply to other datasets in your organization's Soda Cloud account. Soda applies the labels \"good\", \"medium\", and\n\"poor\" based on a 3-ntile split.\n "
}
},
"description": "Information about a dataset including whether a dataset is active or deleted,\nand test coverage metrics."
},
"DatasetsData": {
"title": "DatasetsData",
"type": "object",
"properties": {
"dataset_id": {
"title": "Dataset Id",
"type": "string",
"description": "Identifier (UUID) of the dataset in Soda Cloud."
},
"dataset_name": {
"title": "Dataset Name",
"type": "string",
"description": "Name of the dataset in Soda Cloud corresponding to the name of the dataset in the data source."
},
"dataset_label": {
"title": "Dataset Label",
"type": "string",
"description": "Custom name given to a dataset in Soda Cloud. Will often be identical to dataset_name"
},
"tags": {
"title": "Tags",
"type": "array",
"items": { "type": "string" },
"description": "User-provided list of tags."
},
"creator_info": {
"title": "Creator Info",
"allOf": [{ "$ref": "#/components/schemas/UserInfo" }],
"description": "User information for the creator of the dataset."
},
"owner_info": {
"title": "Owner Info",
"allOf": [{ "$ref": "#/components/schemas/UserInfo" }],
"description": "User information for the owner of the dataset."
},
"number_of_rows": {
"title": "Number Of Rows",
"anyOf": [{ "type": "integer" }, { "type": "string" }],
"description": "Current (and latest known) number of rows in the dataset."
},
"number_of_failed_tests": {
"title": "Number Of Failed Tests",
"anyOf": [{ "type": "integer" }, { "type": "string" }],
"description": "Number of tests that failed on a specific dataset."
},
"last_scan_time": {
"title": "Last Scan Time",
"type": "string",
"description": "UTC timestamp of the last scan run on a dataset.",
"format": "date-time"
},
"datasource_info": {
"title": "Datasource Info",
"allOf": [{ "$ref": "#/components/schemas/DatasourceInfo" }],
"description": "Datasource information"
}
},
"description": "Contains information about a dataset."
},
"DatasetsResult": {
"title": "DatasetsResult",
"required": ["data"],
"type": "object",
"properties": {
"resource": {
"title": "Resource",
"type": "string",
"default": "datasets"
},
"data": {
"title": "Data",
"type": "array",
"items": { "$ref": "#/components/schemas/DatasetsData" }
}
},
"description": "Array of `DatasetsData`."
},
"DatasourceInfo": {
"title": "DatasourceInfo",
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string",
"description": "Unique identifier for the datasource (UUID) in Soda Cloud"
},
"name": {
"title": "Name",
"type": "string",
"description": "Name of the datasource as it appears in Soda Cloud"
},
"label": {
"title": "Label",
"type": "string",
"description": "Label for the datasource as it appears in Soda Cloud"
},
"sourceOwner": {
"title": "Sourceowner",
"type": "string",
"description": "Owner name or label of the datasource"
},
"ownerId": {
"title": "Ownerid",
"type": "string",
"description": "Unique identifier of the Soda Cloud user who onws this datasource"
},
"coreAgentEnabled": {