-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
5292 lines (5243 loc) · 167 KB
/
openapi.yaml
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.0
info:
title: Secoda API
description: >
Use this API to programmatically use Secoda's data enablement features. With
these APIs, you can bring in resource metadata, build documentation
pipelines, and manage workspace settings programmatically.
To learn more about Secoda, visit the [Secoda
documentation](https://docs.secoda.co/).
To get in touch with Secoda, contact customer support at support@secoda.co.
## Getting Started
### Authentication
Secoda API's require an Authorization header with a Bearer token. You can
generate an API key in your workspace, as outlined
[here](https://docs.secoda.co/secoda-api/authentication).
### Base URL
To determine the base URL of your API requests, please refer to the chart
below.
| Workspace URL | Base URL |
| ---------------------- | ---------------------- |
| app.secoda.co | api.secoda.co |
| eu.secoda.co | eapi.secoda.co |
| apac.secoda.co | aapi.secoda.co |
For teams with an On Premise or Managed instance with a custom domain, the
Base URL is the custom domain followed by `/api/v1`.
## Helpful Information
Secoda’s APIs generally follow the CRUD pattern (Create, Read, Update,
Delete). The data elements that are managed with these APIs are called
Resources. Generally, each resource maps to an integration, with many set
and customizable properties called Metadata.
### Important Terminology
**Workspace:**
In Secoda, a workspace is the environment within the application where teams
can integrate resources and metadata and add documentation, either through
the UI or programatically through the API.
**Resource:**
In Secoda, a resource is any entity that metadata can be added to. This
includes, but is not limited to, tables, dashboards, charts, columns,
queries, documents, dictionary terms, and more.
**Metadata:**
In Secoda, metadata is the additional information you can provide to add
context to your resources. This includes descriptions, definitions, owners,
custom properties, and more. Metadata is the lifeblood of Secoda; the more
you put in, the more you'll get out of the tool!
### Resource Heirarchy
Nearly all resources in Secoda can be nested under a parent. A resource has
a one to many relationship with its child. This means thats a parent
resource can have several children, but a child resource can only have one
parent.
For Collections, Dictionary Terms, and Documents, the parent must be the
same resource type. However, there are two unique heirarchy structures that
the application expects when adding net new resources.
**Table Heirarchy:** Integration > Databases > Schemas > Tables > Columns >
Columns (if nested)
**Dashboard Heirarchy:** Integration > Groups > Dashboards > Charts
version: 1.0.0
x-konfig-ignore:
object-with-no-properties: true
servers:
- description: Base URL for all US cloud based workspaces.
url: https://api.secoda.co
- description: Base URL for all EU cloud based workspaces.
url: https://eapi.secoda.co
- description: Base URL for all APAC cloud based workspaces.
url: https://aapi.secoda.co
- description: Base URL for On Premise Secoda workspaces.
url: https://{customer_domain}.secoda.co/api/v1
variables:
customer_domain:
description: The specific domain set up for your On Premise Secoda workspace.
default: customer_domain
tags:
- description: >
Questions asked by data consumers and their associated answers in the
workspace. Learn more about questions
[here](https://docs.secoda.co/features/ask-questions-in-secoda).
name: Questions
- description: >
Metrics in Secoda are a way to centralize, visualize and define your
organization's metrics. Metrics allow you to plug in a query and generate
a graph visualization of that query. Learn more about metrics
[here](https://docs.secoda.co/features/metrics).
name: Metrics
- description: External sources from which resources and metadata are extracted.
name: Integrations
- description: Tables or similar data elements from an integration.
name: Tables
- description: Columns or similar data elements from an integration.
name: Columns
- description: Dashboards or similar visualization elements from an integration.
name: Dashboards
- description: Charts or similar visualization elements from an integration.
name: Charts
- description: Data elements representing an event from an integration.
name: Events
- description: The properties associated with an event from an integration.
name: Event Properties
- description: >-
Labels used to categorize, filter, and classify resources. Learn more
about tags
[here](https://docs.secoda.co/resource-and-metadata-management/tags/custom-tags).
name: Tags
- description: >
Definitions and explanations of specific data-related concepts. Learn more
about terms [here](https://docs.secoda.co/features/metrics).
name: Terms
- description: >
Groups of related resources within the workspace. Learn more about
collections [here](https://docs.secoda.co/features/collections-1).
name: Collections
- description: >
Mark down content used to add documentation to the workspace. Learn more
about documents [here](https://docs.secoda.co/features/documents).
name: Documents
- description: >
Members within the workspace. Learn more about user management
[here](https://docs.secoda.co/user-management).
name: Users
- description: >
Teams within the workspace. Learn more about team management
[here](https://docs.secoda.co/user-management/teams).
name: Teams
- description: >
Groups within the workspace. Learn more about team management
[here](https://docs.secoda.co/user-management/groups).
name: User Groups
- description: >
Monitors allow Secoda admins to have insight into the health of the data
stack. Learn more about monitors
[here](https://docs.secoda.co/features/monitoring).
name: Monitors
- description: Schemas or similar data elements from an integration.
name: Schemas
- description: >
The dependencies between resources. Learn more about lineage
[here](https://docs.secoda.co/features/data-lineage).
name: Lineage
- description: Databases or similar data elements from an integration.
name: Databases
- description: A grouping of related dashboards or charts from an integration.
name: Dashboard Groups
- description: A grouping of related events from an integration.
name: Event Categories
- description: >
Queries from an extraction. Learn more about queries
[here](https://docs.secoda.co/features/queries).
name: Queries
paths:
/integration/integrations:
post:
tags:
- Integrations
summary: Create a New Integration
operationId: Integrations_createNewIntegration
description: >-
Use this endpoint to create a [custom
integration](https://docs.secoda.co/integrations/custom-integration), or
add credentials for a native integration programatically.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationsCreateNewIntegrationRequest'
responses:
'201':
description: Integration created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationResponse'
'400':
description: Bad request.
'500':
description: Internal server error.
get:
tags:
- Integrations
summary: List Integrations
operationId: Integrations_listActive
description: This endpoint will return all the integrations active in your workspace.
parameters:
- description: The type of integrations to filter.
name: type
in: query
schema:
type: string
example: bigquery
responses:
'200':
description: List of integrations.
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationsListActiveResponse'
'400':
description: Bad request.
'500':
description: Internal server error.
/integration/integrations/{integration_id}:
get:
tags:
- Integrations
summary: Get Integration by ID
operationId: Integrations_getById
description: This endpoint will provide the details of an individual integration.
parameters:
- description: The ID of the integration to retrieve.
name: integration_id
in: path
required: true
schema:
type: string
example: d31e59c7-cd52-4398-9d6e-da313a7b7775
responses:
'200':
description: Integration details retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationResponse'
'404':
description: Integration not found.
'500':
description: Internal server error.
/integration/integrations/{integration_id}/import_metadata:
post:
tags:
- Integrations
summary: Upload Integration Metadata (via CSV)
operationId: Integrations_uploadMetadataCsv
description: >-
This endpoint allows the upload of integration metadata using a CSV.
This can also be done through the UI. See more about CSV uploads
[here](https://docs.secoda.co/integrations/custom-integration/import-your-resources).
parameters:
- description: The ID of the integration to upload metadata for.
name: integration_id
in: path
required: true
schema:
type: string
example: d31e59c7-cd52-4398-9d6e-da313a7b7775
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/IntegrationsUploadMetadataCsvRequest'
responses:
'200':
description: Integration metadata uploaded successfully.
'404':
description: Integration not found.
'500':
description: Internal server error.
/integration/integrations/{integration_id}/import_jsonl_metadata:
post:
tags:
- Integrations
summary: Upload Integration Metadata (via JSONL)
operationId: Integrations_uploadJsonlMetadata
description: >-
This endpoint allows the upload of integration metadata as well as
integration lineage using a JSONL file. This can also be done through
the UI. See more about JSONL uploads
[here](https://docs.secoda.co/integrations/custom-integration/import-your-resources).
parameters:
- description: The ID of the integration to upload metadata and/or lineage for.
name: integration_id
in: path
required: true
schema:
type: string
example: d31e59c7-cd52-4398-9d6e-da313a7b7775
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/IntegrationsUploadJsonlMetadataRequest'
responses:
'200':
description: Integration JSONL file uploaded successfully.
'404':
description: Integration not found.
'500':
description: Internal server error.
/table/databases:
post:
tags:
- Databases
summary: Create a New Database
operationId: Databases_createNewDatabase
description: >-
Create a new database resource. It must have a schema as a parent, and
an associated integration.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResourceRequest'
responses:
'201':
description: Database created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResponse'
'400':
description: Bad request.
'500':
description: Internal server error.
get:
tags:
- Databases
summary: List Databases
operationId: Databases_listAllActive
description: Use this endpoint to see all the databases active in your workspace.
parameters:
- description: The title of the database to search for.
in: query
name: title
schema:
type: string
example: customers
responses:
'200':
description: List of databases.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabasesListAllActiveResponse'
'400':
description: Bad request.
'500':
description: Internal server error.
/table/databases/{database_id}:
get:
tags:
- Databases
summary: Get Database by ID
operationId: Databases_getById
description: Use this endpoint for retrieving a specific database by its ID.
parameters:
- description: The unique identifier of the database to retrieve.
in: path
name: database_id
required: true
schema:
type: string
example: 27498d73-db31-4a4e-8cf0-faccff1bed0f
responses:
'200':
description: Database retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResponse'
'404':
description: Database not found.
'500':
description: Internal server error.
/table/schemas:
post:
tags:
- Schemas
summary: Create a New Schema
operationId: Schemas_createNewSchema
description: >-
Create a new schema. Schema must have one database as a parent, and be
associated with an integration.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResourceRequest'
responses:
'201':
description: Schema created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResponse'
'400':
description: Bad request.
'500':
description: Internal server error.
get:
tags:
- Schemas
summary: List Schemas
operationId: Schemas_listWithFilter
description: >-
Endpoint for retrieving a list of schemas with optional filtering by
parent schema and title.
parameters:
- description: The ID of the parent database to filter by.
in: query
name: parent
schema:
type: string
- description: The title of the schema to filter by.
in: query
name: title
schema:
type: string
responses:
'200':
description: List of schemas.
content:
application/json:
schema:
$ref: '#/components/schemas/SchemasListWithFilterResponse'
'400':
description: Bad request.
'500':
description: Internal server error.
/table/schemas/{schema_id}:
parameters:
- description: The ID of the schema to retrieve or update.
in: path
name: schema_id
required: true
example: df2c0597-13d9-4159-bb6d-00b3f54235dc
schema:
type: string
get:
tags:
- Schemas
summary: Get Schema by ID
operationId: Schemas_getById
description: Retrieve schema details by its unique ID.
responses:
'200':
description: Schema details retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResponse'
'404':
description: Schema not found.
'500':
description: Internal server error.
patch:
tags:
- Schemas
summary: Update Schema by ID
operationId: Schemas_updateById
description: Use this endpoint to update schema metadata.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BasePatchRequest'
responses:
'200':
description: Schema updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResponse'
'400':
description: Bad request.
'404':
description: Schema not found.
'500':
description: Internal server error.
/table/tables:
post:
tags:
- Tables
summary: Create a New Table
operationId: Tables_createNewTable
description: >-
Create a new table with a schema as a parent. The table must be
associated with an integration.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResourceRequest'
responses:
'201':
description: Table created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/TableResponse'
'400':
description: Bad request.
'500':
description: Internal server error.
get:
tags:
- Tables
summary: List Tables
operationId: Tables_listTablesByFilter
description: >
This endpoint retrieves a list of tables, with optional filters for the
integration, the schema, and the title of the table resource.
parameters:
- description: Integration ID
name: integration_id
in: query
schema:
type: string
example: df2c0597-13d9-4159-bb6d-00b3f54235dc
- description: ID of the schema
name: parent_id
in: query
schema:
type: string
example: df2c0597-13d9-4159-bb6d-00b3f54235dc
- description: Title of the table
name: title
in: query
schema:
type: string
example: Sample Table
responses:
'200':
description: List of databases.
content:
application/json:
schema:
$ref: '#/components/schemas/TablesListTablesByFilterResponse'
'400':
description: Bad request.
'500':
description: Internal server error.
/table/tables/{table_id}:
get:
tags:
- Tables
summary: Get Table by ID
operationId: Tables_getTableById
description: |
This endpoint retrieves a specific table by its ID.
parameters:
- description: ID of the table to retrieve
name: table_id
in: path
required: true
schema:
type: string
example: d935a76c-2125-4c30-9389-ef42fa7e23bb
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/TableResponse'
'404':
description: Table not found.
'500':
description: Internal server error.
patch:
tags:
- Tables
summary: Update Table by ID
operationId: Tables_updateById
description: |
Use this endpoint to update table metadata.
parameters:
- description: ID of the table to update
name: table_id
in: path
required: true
schema:
type: string
example: d935a76c-2125-4c30-9389-ef42fa7e23bb
requestBody:
description: Table data to update
content:
application/json:
schema:
$ref: '#/components/schemas/BasePatchRequest'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/TableResponse'
'400':
description: Bad request.
'404':
description: Table not found.
'500':
description: Internal server error.
delete:
tags:
- Tables
summary: Delete Table by ID
operationId: Tables_deleteById
description: |
This endpoint deletes a specific table by its ID.
parameters:
- description: ID of the table to delete
name: table_id
in: path
required: true
schema:
type: string
example: e7691426-2c2a-46b4-98e7-d09d0b82b2b1
responses:
'204':
description: Table deleted successfully
'404':
description: Table not found.
'500':
description: Internal server error.
/table/columns:
post:
tags:
- Columns
summary: Create a New Column
operationId: Columns_createNewColumn
description: >
This endpoint allows you to create a new column. Columns must have
tables as a parent or another column for nested records. Columns must be
associated with an integration.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResourceRequest'
responses:
'201':
description: Column created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/ColumnResponse'
'400':
description: Bad request.
'500':
description: Internal server error.
get:
tags:
- Columns
summary: List Columns
operationId: Columns_getList
description: >
This endpoint allows you to retrieve a list of all columns in the
workspace. Optional filters for integration_id, title, and parent_id
(the table or parent column) are available.
parameters:
- description: Optional. Filter columns by integration identifier.
name: integration_id
in: query
schema:
type: string
example: 6c69de0f-b269-4380-bcf5-0686de276b9e
- description: >-
Optional. Filter columns by parent identifier. This could be the ID
of the table or of the parent column in the case of nested columns.
name: parent_id
in: query
schema:
type: string
example: c444bc26-433e-4cd2-b3ee-f5a1fbb2caf8
- description: Optional. Filter columns by title of the column.
name: title
in: query
schema:
type: string
example: Sample Column
- description: >-
Optional. Filter columns by title of the table that the columns
belong to. If several integrations have the same naming of tables,
it is recommended to combine this with the `integration_id`.
name: table_title
in: query
schema:
type: string
example: Sample Table
responses:
'200':
description: List of columns.
content:
application/json:
schema:
$ref: '#/components/schemas/ColumnsGetListResponse'
'400':
description: Bad request.
'500':
description: Internal server error.
/table/columns/{column_id}:
get:
tags:
- Columns
summary: Get Column by ID
operationId: Columns_getColumnById
description: >
This endpoint allows you to retrieve information about a specific column
by its identifier.
parameters:
- description: Identifier of the column to retrieve.
name: column_id
in: path
required: true
schema:
type: string
example: 8b2e01e0-603b-4559-8eac-4e16ecc61fc7
responses:
'200':
description: Column retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/ColumnResponse'
'404':
description: Column not found.
'500':
description: Internal server error.
patch:
tags:
- Columns
summary: Edit Column by ID
operationId: Columns_editById
description: >
This endpoint allows you to edit the metadata of a specific column by
its identifier.
parameters:
- description: Identifier of the column to retrieve.
name: column_id
in: path
required: true
schema:
type: string
example: 8b2e01e0-603b-4559-8eac-4e16ecc61fc7
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BasePatchRequest'
responses:
'200':
description: Column retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/ColumnResponse'
'404':
description: Column not found.
'500':
description: Internal server error.
delete:
tags:
- Columns
summary: Delete Column by ID
operationId: Columns_deleteById
description: |
This endpoint allows you to delete a specific column by its identifier.
parameters:
- description: Identifier of the column to delete.
name: column_id
in: path
required: true
schema:
type: string
example: 8b2e01e0-603b-4559-8eac-4e16ecc61fc7
responses:
'204':
description: Column deleted successfully.
'404':
description: Column not found.
'500':
description: Internal server error.
/dashboard/groups:
post:
tags:
- Dashboard Groups
summary: Create a New Dashboard Group
operationId: DashboardGroups_createNewGroup
description: >-
Use this endpoint to create a dashboard group, which will be the parent
of dashboards.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResourceRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/DashboardGroupResponse'
'400':
description: Bad Request
'500':
description: Internal Server Error
get:
tags:
- Dashboard Groups
summary: List Dashboard Groups
operationId: DashboardGroups_list
description: >-
List all the dashboard groups in the workspace. Optional filter by
title.
parameters:
- description: Filter groups by title
in: query
name: title
schema:
type: string
example: Sample Group
responses:
'200':
description: List of groups.
content:
application/json:
schema:
$ref: '#/components/schemas/DashboardGroupsListResponse'
'400':
description: Bad Request
'500':
description: Internal Server Error
/dashboard/groups/{group_id}:
get:
tags:
- Dashboard Groups
summary: Get Dashboard Group by ID
operationId: DashboardGroups_getById
description: Retrieve the information of a specific dashboard group.
parameters:
- description: ID of the dashboard group to retrieve
in: path
name: group_id
required: true
schema:
type: string
example: 43d7c33d-ad74-4dfb-bfad-c172f6701afb
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DashboardGroupResponse'
'404':
description: Not Found
'500':
description: Internal Server Error
/dashboard/dashboards:
post:
tags:
- Dashboards
summary: Create a new Dashboard
operationId: Dashboards_createNewDashboard
description: >
Create a new dashboard with the provided data. Dashboards must have a
Group as a parent, and be associated with an integration.
requestBody:
description: Dashboard data
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResourceRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/DashboardResponse'
'400':
description: Bad Request
'500':
description: Internal Server Error
get:
tags:
- Dashboards
summary: List Dashboards
operationId: Dashboards_listWithFilter
description: >
Retrieve a list of dashboards with optional filtering using the
integration_id, parent_id (the dashboard group), and title.
parameters:
- description: Filter by integration ID
name: integration_id
in: query
schema:
type: string
example: cf103b47-8576-4467-ad34-384cd523abd9
- description: Filter by parent ID
name: parent_id
in: query
schema:
type: string
example: 43d7c33d-ad74-4dfb-bfad-c172f6701afb
- description: Filter by title
name: title
in: query
schema:
type: string
example: Sample Dashboard
responses:
'200':
description: List of dashboards.
content:
application/json:
schema:
$ref: '#/components/schemas/DashboardsListWithFilterResponse'
'400':
description: Bad Request
'500':
description: Internal Server Error
/dashboard/dashboards/{dashboard_id}:
get:
tags:
- Dashboards
summary: Get Dashboard by ID
operationId: Dashboards_getById
description: |
Retrieve a specific dashboard by its ID.
parameters:
- description: The ID of the dashboard to retrieve.
name: dashboard_id
in: path
required: true
schema:
type: string
example: 226dc8aa-fa8d-4646-8b11-6652cdc64065
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DashboardResponse'
'404':
description: Not Found
'500':
description: Internal Server Error
patch:
tags:
- Dashboards
summary: Update Dashboard by ID
operationId: Dashboards_updateById
description: |
Use this endpoint to update dashboard metadata.
parameters: