@gooddata/api-client-tiger 11.15.0-alpha.9 → 11.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. package/esm/__version.d.ts +1 -1
  2. package/esm/__version.d.ts.map +1 -1
  3. package/esm/__version.js +1 -1
  4. package/esm/__version.js.map +1 -1
  5. package/package.json +11 -11
  6. package/esm/generated/afm-rest-api/openapi-spec.json +0 -5469
  7. package/esm/generated/auth-json-api/openapi-spec.json +0 -540
  8. package/esm/generated/automation-json-api/openapi-spec.json +0 -3144
  9. package/esm/generated/export-json-api/openapi-spec.json +0 -2645
  10. package/esm/generated/metadata-json-api/openapi-spec.json +0 -39195
  11. package/esm/generated/result-json-api/openapi-spec.json +0 -1102
  12. package/esm/generated/scan-json-api/openapi-spec.json +0 -1052
package/esm/generated/automation-json-api/openapi-spec.json DELETED
@@ -1,3144 +0,0 @@
1
- {
2
- "openapi": "3.0.1",
3
- "info": {
4
- "title": "OpenAPI definition",
5
- "version": "v0"
6
- },
7
- "servers": [
8
- {
9
- "url": "/",
10
- "description": "GoodData.CN endpoint"
11
- }
12
- ],
13
- "tags": [
14
- {
15
- "name": "actions",
16
- "description": "| execution of some form of computation (RPC over JSON)"
17
- }
18
- ],
19
- "paths": {
20
- "/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger": {
21
- "post": {
22
- "tags": ["Automations", "actions"],
23
- "summary": "Trigger existing automation.",
24
- "description": "Trigger the existing automation to execute immediately.",
25
- "operationId": "triggerExistingAutomation",
26
- "parameters": [
27
- {
28
- "name": "workspaceId",
29
- "in": "path",
30
- "required": true,
31
- "schema": {
32
- "type": "string"
33
- }
34
- },
35
- {
36
- "name": "automationId",
37
- "in": "path",
38
- "required": true,
39
- "schema": {
40
- "type": "string"
41
- }
42
- }
43
- ],
44
- "responses": {
45
- "204": {
46
- "description": "The automation is successfully triggered."
47
- }
48
- }
49
- }
50
- },
51
- "/api/v1/actions/workspaces/{workspaceId}/automations/trigger": {
52
- "post": {
53
- "tags": ["Automations", "actions"],
54
- "summary": "Trigger automation.",
55
- "description": "Trigger the automation in the request.",
56
- "operationId": "triggerAutomation",
57
- "parameters": [
58
- {
59
- "name": "workspaceId",
60
- "in": "path",
61
- "required": true,
62
- "schema": {
63
- "type": "string"
64
- }
65
- }
66
- ],
67
- "requestBody": {
68
- "content": {
69
- "application/json": {
70
- "schema": {
71
- "$ref": "#/components/schemas/TriggerAutomationRequest"
72
- }
73
- }
74
- },
75
- "required": true
76
- },
77
- "responses": {
78
- "204": {
79
- "description": "The automation is successfully triggered."
80
- }
81
- }
82
- }
83
- },
84
- "/api/v1/actions/notifications/{notificationId}/markAsRead": {
85
- "post": {
86
- "tags": ["Notification Channels", "actions"],
87
- "summary": "Mark notification as read.",
88
- "description": "Mark in-platform notification by its ID as read.",
89
- "operationId": "markAsReadNotification",
90
- "parameters": [
91
- {
92
- "name": "notificationId",
93
- "in": "path",
94
- "description": "Notification ID to mark as read.",
95
- "required": true,
96
- "schema": {
97
- "type": "string"
98
- }
99
- }
100
- ],
101
- "responses": {
102
- "204": {
103
- "description": "No Content"
104
- }
105
- }
106
- }
107
- },
108
- "/api/v1/actions/notifications/markAsRead": {
109
- "post": {
110
- "tags": ["Notification Channels", "actions"],
111
- "summary": "Mark all notifications as read.",
112
- "description": "Mark all user in-platform notifications as read.",
113
- "operationId": "markAsReadNotificationAll",
114
- "parameters": [
115
- {
116
- "name": "workspaceId",
117
- "in": "query",
118
- "description": "Workspace ID where to mark notifications as read.",
119
- "required": false,
120
- "style": "form",
121
- "schema": {
122
- "type": "string"
123
- }
124
- }
125
- ],
126
- "responses": {
127
- "204": {
128
- "description": "No Content"
129
- }
130
- }
131
- }
132
- },
133
- "/api/v1/actions/notificationChannels/{notificationChannelId}/test": {
134
- "post": {
135
- "tags": ["Notification Channels", "actions"],
136
- "summary": "Test existing notification channel.",
137
- "description": "Tests the existing notification channel by sending a test notification.",
138
- "operationId": "testExistingNotificationChannel",
139
- "parameters": [
140
- {
141
- "name": "notificationChannelId",
142
- "in": "path",
143
- "required": true,
144
- "schema": {
145
- "type": "string"
146
- }
147
- }
148
- ],
149
- "requestBody": {
150
- "content": {
151
- "application/json": {
152
- "schema": {
153
- "$ref": "#/components/schemas/TestDestinationRequest"
154
- }
155
- }
156
- }
157
- },
158
- "responses": {
159
- "200": {
160
- "description": "The result of the test of a notification channel connection.",
161
- "content": {
162
- "application/json": {
163
- "schema": {
164
- "$ref": "#/components/schemas/TestResponse"
165
- },
166
- "examples": {
167
- "An example of a successful connection": {
168
- "description": "An example of a successful connection",
169
- "value": {
170
- "successful": true
171
- }
172
- },
173
- "An example of an unsuccessful connection": {
174
- "description": "An example of an unsuccessful connection",
175
- "value": {
176
- "successful": false,
177
- "error": "Authentication failed"
178
- }
179
- }
180
- }
181
- }
182
- }
183
- }
184
- }
185
- }
186
- },
187
- "/api/v1/actions/notificationChannels/test": {
188
- "post": {
189
- "tags": ["Notification Channels", "actions"],
190
- "summary": "Test notification channel.",
191
- "description": "Tests the notification channel by sending a test notification.",
192
- "operationId": "testNotificationChannel",
193
- "requestBody": {
194
- "content": {
195
- "application/json": {
196
- "schema": {
197
- "$ref": "#/components/schemas/TestDestinationRequest"
198
- }
199
- }
200
- },
201
- "required": true
202
- },
203
- "responses": {
204
- "200": {
205
- "description": "The result of the test of a notification channel connection.",
206
- "content": {
207
- "application/json": {
208
- "schema": {
209
- "$ref": "#/components/schemas/TestResponse"
210
- },
211
- "examples": {
212
- "An example of a successful connection": {
213
- "description": "An example of a successful connection",
214
- "value": {
215
- "successful": true
216
- }
217
- },
218
- "An example of an unsuccessful connection": {
219
- "description": "An example of an unsuccessful connection",
220
- "value": {
221
- "successful": false,
222
- "error": "Authentication failed"
223
- }
224
- }
225
- }
226
- }
227
- }
228
- }
229
- }
230
- }
231
- },
232
- "/api/v1/actions/notifications": {
233
- "get": {
234
- "tags": ["Notification Channels", "actions"],
235
- "summary": "Get latest notifications.",
236
- "description": "Get latest in-platform notifications for the current user.",
237
- "operationId": "getNotifications",
238
- "parameters": [
239
- {
240
- "name": "workspaceId",
241
- "in": "query",
242
- "description": "Workspace ID to filter notifications by.",
243
- "required": false,
244
- "style": "form",
245
- "schema": {
246
- "type": "string"
247
- }
248
- },
249
- {
250
- "name": "isRead",
251
- "in": "query",
252
- "description": "Filter notifications by read status.",
253
- "required": false,
254
- "style": "form",
255
- "schema": {
256
- "type": "boolean"
257
- }
258
- },
259
- {
260
- "name": "page",
261
- "in": "query",
262
- "description": "Zero-based page index (0..N)",
263
- "required": false,
264
- "style": "form",
265
- "schema": {
266
- "minimum": 0,
267
- "type": "string",
268
- "default": "0"
269
- }
270
- },
271
- {
272
- "name": "size",
273
- "in": "query",
274
- "description": "The size of the page to be returned.",
275
- "required": false,
276
- "style": "form",
277
- "schema": {
278
- "minimum": 1,
279
- "type": "string",
280
- "default": "20"
281
- }
282
- },
283
- {
284
- "name": "metaInclude",
285
- "in": "query",
286
- "description": "Additional meta information to include in the response.",
287
- "required": false,
288
- "style": "form",
289
- "explode": true,
290
- "schema": {
291
- "uniqueItems": true,
292
- "type": "array",
293
- "items": {
294
- "type": "string",
295
- "enum": ["total", "ALL"]
296
- }
297
- }
298
- }
299
- ],
300
- "responses": {
301
- "200": {
302
- "description": "OK",
303
- "content": {
304
- "application/json": {
305
- "schema": {
306
- "$ref": "#/components/schemas/Notifications"
307
- }
308
- }
309
- }
310
- }
311
- }
312
- }
313
- }
314
- },
315
- "components": {
316
- "schemas": {
317
- "AFM": {
318
- "required": ["attributes", "filters", "measures"],
319
- "type": "object",
320
- "properties": {
321
- "attributes": {
322
- "type": "array",
323
- "description": "Attributes to be used in the computation.",
324
- "items": {
325
- "$ref": "#/components/schemas/AttributeItem"
326
- }
327
- },
328
- "filters": {
329
- "type": "array",
330
- "description": "Various filter types to filter the execution result.",
331
- "items": {
332
- "oneOf": [
333
- {
334
- "$ref": "#/components/schemas/AbstractMeasureValueFilter"
335
- },
336
- {
337
- "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure"
338
- },
339
- {
340
- "$ref": "#/components/schemas/InlineFilterDefinition"
341
- }
342
- ]
343
- }
344
- },
345
- "measures": {
346
- "type": "array",
347
- "description": "Metrics to be computed.",
348
- "items": {
349
- "$ref": "#/components/schemas/MeasureItem"
350
- }
351
- },
352
- "auxMeasures": {
353
- "type": "array",
354
- "description": "Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.",
355
- "items": {
356
- "$ref": "#/components/schemas/MeasureItem"
357
- }
358
- }
359
- },
360
- "description": "Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics."
361
- },
362
- "AbsoluteDateFilter": {
363
- "required": ["absoluteDateFilter"],
364
- "type": "object",
365
- "properties": {
366
- "absoluteDateFilter": {
367
- "required": ["from", "to", "dataset"],
368
- "type": "object",
369
- "properties": {
370
- "from": {
371
- "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$",
372
- "type": "string",
373
- "example": "2020-07-01 18:23"
374
- },
375
- "to": {
376
- "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$",
377
- "type": "string",
378
- "example": "2020-07-16 23:59"
379
- },
380
- "localIdentifier": {
381
- "type": "string"
382
- },
383
- "applyOnResult": {
384
- "type": "boolean"
385
- },
386
- "dataset": {
387
- "$ref": "#/components/schemas/AfmObjectIdentifierDataset"
388
- }
389
- }
390
- }
391
- },
392
- "description": "A datetime filter specifying exact from and to values."
393
- },
394
- "AbstractMeasureValueFilter": {
395
- "type": "object",
396
- "oneOf": [
397
- {
398
- "$ref": "#/components/schemas/ComparisonMeasureValueFilter"
399
- },
400
- {
401
- "$ref": "#/components/schemas/RangeMeasureValueFilter"
402
- },
403
- {
404
- "$ref": "#/components/schemas/RankingFilter"
405
- }
406
- ]
407
- },
408
- "AdHocAutomation": {
409
- "type": "object",
410
- "properties": {
411
- "title": {
412
- "maxLength": 255,
413
- "type": "string"
414
- },
415
- "description": {
416
- "maxLength": 255,
417
- "type": "string"
418
- },
419
- "tags": {
420
- "uniqueItems": true,
421
- "type": "array",
422
- "description": "A list of tags.",
423
- "example": ["Revenue", "Sales"],
424
- "items": {
425
- "type": "string"
426
- }
427
- },
428
- "details": {
429
- "maxLength": 10000,
430
- "type": "object",
431
- "additionalProperties": {
432
- "maxLength": 10000,
433
- "type": "string",
434
- "description": "Additional details to be included in the automated message."
435
- },
436
- "description": "Additional details to be included in the automated message."
437
- },
438
- "metadata": {
439
- "$ref": "#/components/schemas/AutomationMetadata"
440
- },
441
- "alert": {
442
- "$ref": "#/components/schemas/AutomationAlert"
443
- },
444
- "tabularExports": {
445
- "uniqueItems": true,
446
- "type": "array",
447
- "items": {
448
- "$ref": "#/components/schemas/AutomationTabularExport"
449
- }
450
- },
451
- "visualExports": {
452
- "uniqueItems": true,
453
- "type": "array",
454
- "items": {
455
- "$ref": "#/components/schemas/AutomationVisualExport"
456
- }
457
- },
458
- "imageExports": {
459
- "uniqueItems": true,
460
- "type": "array",
461
- "items": {
462
- "$ref": "#/components/schemas/AutomationImageExport"
463
- }
464
- },
465
- "rawExports": {
466
- "uniqueItems": true,
467
- "type": "array",
468
- "items": {
469
- "$ref": "#/components/schemas/AutomationRawExport"
470
- }
471
- },
472
- "slidesExports": {
473
- "uniqueItems": true,
474
- "type": "array",
475
- "items": {
476
- "$ref": "#/components/schemas/AutomationSlidesExport"
477
- }
478
- },
479
- "dashboardTabularExports": {
480
- "uniqueItems": true,
481
- "type": "array",
482
- "items": {
483
- "$ref": "#/components/schemas/AutomationDashboardTabularExport"
484
- }
485
- },
486
- "externalRecipients": {
487
- "uniqueItems": true,
488
- "type": "array",
489
- "description": "External recipients of the automation action results.",
490
- "items": {
491
- "$ref": "#/components/schemas/AutomationExternalRecipient"
492
- }
493
- },
494
- "notificationChannel": {
495
- "$ref": "#/components/schemas/DeclarativeNotificationChannelIdentifier"
496
- },
497
- "recipients": {
498
- "uniqueItems": true,
499
- "type": "array",
500
- "items": {
501
- "$ref": "#/components/schemas/DeclarativeUserIdentifier"
502
- }
503
- },
504
- "analyticalDashboard": {
505
- "$ref": "#/components/schemas/DeclarativeAnalyticalDashboardIdentifier"
506
- }
507
- }
508
- },
509
- "AfmIdentifier": {
510
- "type": "object",
511
- "description": "Reference to the attribute label to which the filter should be applied.",
512
- "oneOf": [
513
- {
514
- "$ref": "#/components/schemas/AfmObjectIdentifier"
515
- },
516
- {
517
- "$ref": "#/components/schemas/AfmLocalIdentifier"
518
- }
519
- ]
520
- },
521
- "AfmLocalIdentifier": {
522
- "required": ["localIdentifier"],
523
- "type": "object",
524
- "properties": {
525
- "localIdentifier": {
526
- "pattern": "^[.a-zA-Z0-9_-]+$",
527
- "type": "string",
528
- "example": "sampleAutoGenerated0123_ID"
529
- }
530
- }
531
- },
532
- "AfmObjectIdentifier": {
533
- "required": ["identifier"],
534
- "type": "object",
535
- "properties": {
536
- "identifier": {
537
- "required": ["type", "id"],
538
- "type": "object",
539
- "properties": {
540
- "type": {
541
- "type": "string",
542
- "example": "fact",
543
- "enum": [
544
- "analyticalDashboard",
545
- "attribute",
546
- "dashboardPlugin",
547
- "dataset",
548
- "fact",
549
- "label",
550
- "metric",
551
- "prompt",
552
- "visualizationObject",
553
- "filterContext"
554
- ]
555
- },
556
- "id": {
557
- "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
558
- "type": "string",
559
- "example": "sample_item.price"
560
- }
561
- }
562
- }
563
- },
564
- "description": "ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers."
565
- },
566
- "AfmObjectIdentifierAttribute": {
567
- "required": ["identifier"],
568
- "type": "object",
569
- "properties": {
570
- "identifier": {
571
- "required": ["id", "type"],
572
- "type": "object",
573
- "properties": {
574
- "id": {
575
- "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
576
- "type": "string",
577
- "example": "sample_item.price"
578
- },
579
- "type": {
580
- "type": "string",
581
- "enum": ["attribute"]
582
- }
583
- }
584
- }
585
- },
586
- "description": "Reference to the date attribute to use."
587
- },
588
- "AfmObjectIdentifierCore": {
589
- "required": ["identifier"],
590
- "type": "object",
591
- "properties": {
592
- "identifier": {
593
- "required": ["id", "type"],
594
- "type": "object",
595
- "properties": {
596
- "id": {
597
- "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
598
- "type": "string",
599
- "example": "sample_item.price"
600
- },
601
- "type": {
602
- "type": "string",
603
- "enum": ["attribute", "label", "fact", "metric"]
604
- }
605
- }
606
- }
607
- },
608
- "description": "Reference to the metric, fact or attribute object to use for the metric."
609
- },
610
- "AfmObjectIdentifierDataset": {
611
- "required": ["identifier"],
612
- "type": "object",
613
- "properties": {
614
- "identifier": {
615
- "required": ["id", "type"],
616
- "type": "object",
617
- "properties": {
618
- "id": {
619
- "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
620
- "type": "string",
621
- "example": "sample_item.price"
622
- },
623
- "type": {
624
- "type": "string",
625
- "enum": ["dataset"]
626
- }
627
- }
628
- }
629
- },
630
- "description": "Date dataset used for anomaly detection."
631
- },
632
- "AfmObjectIdentifierLabel": {
633
- "required": ["identifier"],
634
- "type": "object",
635
- "properties": {
636
- "identifier": {
637
- "required": ["type", "id"],
638
- "type": "object",
639
- "properties": {
640
- "type": {
641
- "type": "string",
642
- "enum": ["label"]
643
- },
644
- "id": {
645
- "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
646
- "type": "string",
647
- "example": "sample_item.price"
648
- }
649
- }
650
- }
651
- }
652
- },
653
- "AlertAfm": {
654
- "required": ["filters", "measures"],
655
- "type": "object",
656
- "properties": {
657
- "attributes": {
658
- "maximum": 1,
659
- "type": "array",
660
- "description": "Attributes to be used in the computation.",
661
- "items": {
662
- "$ref": "#/components/schemas/AttributeItem"
663
- }
664
- },
665
- "filters": {
666
- "type": "array",
667
- "description": "Various filter types to filter execution result. For anomaly detection, exactly one dataset is specified in the condition. The AFM may contain multiple date filters for different datasets, but only the date filter matching the dataset from the condition is used for anomaly detection.",
668
- "items": {
669
- "$ref": "#/components/schemas/FilterDefinition"
670
- }
671
- },
672
- "measures": {
673
- "maximum": 2,
674
- "minimum": 1,
675
- "type": "array",
676
- "description": "Metrics to be computed. One metric if the alert condition is evaluated to a scalar. Two metrics when they should be evaluated to each other.",
677
- "items": {
678
- "$ref": "#/components/schemas/MeasureItem"
679
- }
680
- },
681
- "auxMeasures": {
682
- "type": "array",
683
- "description": "Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.",
684
- "items": {
685
- "$ref": "#/components/schemas/MeasureItem"
686
- }
687
- }
688
- }
689
- },
690
- "AlertCondition": {
691
- "type": "object",
692
- "description": "Alert trigger condition.",
693
- "oneOf": [
694
- {
695
- "$ref": "#/components/schemas/ComparisonWrapper"
696
- },
697
- {
698
- "$ref": "#/components/schemas/RangeWrapper"
699
- },
700
- {
701
- "$ref": "#/components/schemas/RelativeWrapper"
702
- },
703
- {
704
- "$ref": "#/components/schemas/AnomalyDetectionWrapper"
705
- }
706
- ]
707
- },
708
- "AlertConditionOperand": {
709
- "type": "object",
710
- "description": "Operand of the alert condition.",
711
- "oneOf": [
712
- {
713
- "$ref": "#/components/schemas/LocalIdentifier"
714
- },
715
- {
716
- "$ref": "#/components/schemas/Value"
717
- }
718
- ]
719
- },
720
- "AnomalyDetection": {
721
- "required": ["dataset", "granularity", "measure", "sensitivity"],
722
- "type": "object",
723
- "properties": {
724
- "measure": {
725
- "$ref": "#/components/schemas/LocalIdentifier"
726
- },
727
- "sensitivity": {
728
- "type": "string",
729
- "description": "Sensitivity level for anomaly detection",
730
- "enum": ["LOW", "MEDIUM", "HIGH"]
731
- },
732
- "granularity": {
733
- "type": "string",
734
- "description": "Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR).",
735
- "enum": ["HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"]
736
- },
737
- "dataset": {
738
- "$ref": "#/components/schemas/AfmObjectIdentifierDataset"
739
- }
740
- }
741
- },
742
- "AnomalyDetectionWrapper": {
743
- "required": ["anomaly"],
744
- "type": "object",
745
- "properties": {
746
- "anomaly": {
747
- "$ref": "#/components/schemas/AnomalyDetection"
748
- }
749
- }
750
- },
751
- "ArithmeticMeasure": {
752
- "required": ["left", "operator", "right"],
753
- "type": "object",
754
- "properties": {
755
- "operator": {
756
- "type": "string",
757
- "description": "Arithmetic operator.\nDIFFERENCE - m₁−m₂ - the difference between two metrics.\nCHANGE - (m₁−m₂)÷m₂ - the relative difference between two metrics.\n",
758
- "enum": ["DIFFERENCE", "CHANGE"]
759
- },
760
- "left": {
761
- "$ref": "#/components/schemas/LocalIdentifier"
762
- },
763
- "right": {
764
- "$ref": "#/components/schemas/LocalIdentifier"
765
- }
766
- }
767
- },
768
- "ArithmeticMeasureDefinition": {
769
- "required": ["arithmeticMeasure"],
770
- "type": "object",
771
- "properties": {
772
- "arithmeticMeasure": {
773
- "required": ["measureIdentifiers", "operator"],
774
- "type": "object",
775
- "properties": {
776
- "measureIdentifiers": {
777
- "type": "array",
778
- "description": "List of metrics to apply arithmetic operation by chosen operator.",
779
- "items": {
780
- "$ref": "#/components/schemas/AfmLocalIdentifier"
781
- }
782
- },
783
- "operator": {
784
- "type": "string",
785
- "description": "Arithmetic operator describing operation between metrics.",
786
- "example": "SUM",
787
- "enum": ["SUM", "DIFFERENCE", "MULTIPLICATION", "RATIO", "CHANGE"]
788
- }
789
- }
790
- }
791
- },
792
- "description": "Metric representing arithmetics between other metrics."
793
- },
794
- "AttributeElements": {
795
- "type": "object",
796
- "oneOf": [
797
- {
798
- "$ref": "#/components/schemas/AttributeElementsByRef"
799
- },
800
- {
801
- "$ref": "#/components/schemas/AttributeElementsByValue"
802
- }
803
- ]
804
- },
805
- "AttributeElementsByRef": {
806
- "required": ["uris"],
807
- "type": "object",
808
- "properties": {
809
- "uris": {
810
- "type": "array",
811
- "description": "List of attribute elements by reference",
812
- "items": {
813
- "type": "string",
814
- "nullable": true
815
- }
816
- }
817
- }
818
- },
819
- "AttributeElementsByValue": {
820
- "required": ["values"],
821
- "type": "object",
822
- "properties": {
823
- "values": {
824
- "type": "array",
825
- "description": "List of attribute elements by value",
826
- "items": {
827
- "type": "string",
828
- "nullable": true
829
- }
830
- }
831
- }
832
- },
833
- "AttributeFilter": {
834
- "type": "object",
835
- "description": "Abstract filter definition type attributes",
836
- "oneOf": [
837
- {
838
- "$ref": "#/components/schemas/NegativeAttributeFilter"
839
- },
840
- {
841
- "$ref": "#/components/schemas/PositiveAttributeFilter"
842
- }
843
- ]
844
- },
845
- "AttributeFilterByDate": {
846
- "required": ["filterLocalIdentifier", "isCommonDate"],
847
- "type": "object",
848
- "properties": {
849
- "filterLocalIdentifier": {
850
- "type": "string"
851
- },
852
- "isCommonDate": {
853
- "type": "boolean"
854
- }
855
- }
856
- },
857
- "AttributeFilterElements": {
858
- "required": ["values"],
859
- "type": "object",
860
- "properties": {
861
- "values": {
862
- "uniqueItems": true,
863
- "type": "array",
864
- "description": "Set of label values.",
865
- "example": ["value1", "value2"],
866
- "items": {
867
- "type": "string",
868
- "nullable": true
869
- }
870
- }
871
- },
872
- "description": "Filter on specific set of label values."
873
- },
874
- "AttributeFilterParent": {
875
- "required": ["filterLocalIdentifier", "over"],
876
- "type": "object",
877
- "properties": {
878
- "filterLocalIdentifier": {
879
- "type": "string"
880
- },
881
- "over": {
882
- "$ref": "#/components/schemas/Over"
883
- }
884
- }
885
- },
886
- "AttributeItem": {
887
- "required": ["label", "localIdentifier"],
888
- "type": "object",
889
- "properties": {
890
- "localIdentifier": {
891
- "pattern": "^[.a-zA-Z0-9_-]+$",
892
- "type": "string",
893
- "description": "Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.",
894
- "example": "attribute_1"
895
- },
896
- "label": {
897
- "$ref": "#/components/schemas/AfmObjectIdentifierLabel"
898
- },
899
- "showAllValues": {
900
- "type": "boolean",
901
- "description": "Indicates whether to show all values of given attribute even if the data bound to those values is not available.",
902
- "default": false
903
- }
904
- }
905
- },
906
- "AutomationAlert": {
907
- "required": ["condition", "execution"],
908
- "type": "object",
909
- "properties": {
910
- "execution": {
911
- "$ref": "#/components/schemas/AlertAfm"
912
- },
913
- "condition": {
914
- "oneOf": [
915
- {
916
- "$ref": "#/components/schemas/AnomalyDetectionWrapper"
917
- },
918
- {
919
- "$ref": "#/components/schemas/ComparisonWrapper"
920
- },
921
- {
922
- "$ref": "#/components/schemas/RangeWrapper"
923
- },
924
- {
925
- "$ref": "#/components/schemas/RelativeWrapper"
926
- }
927
- ]
928
- },
929
- "trigger": {
930
- "type": "string",
931
- "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\n",
932
- "default": "ALWAYS",
933
- "enum": ["ALWAYS", "ONCE"]
934
- }
935
- }
936
- },
937
- "AutomationDashboardTabularExport": {
938
- "required": ["requestPayload"],
939
- "type": "object",
940
- "properties": {
941
- "requestPayload": {
942
- "$ref": "#/components/schemas/DashboardTabularExportRequestV2"
943
- }
944
- }
945
- },
946
- "AutomationExternalRecipient": {
947
- "required": ["email"],
948
- "type": "object",
949
- "properties": {
950
- "email": {
951
- "type": "string",
952
- "description": "E-mail address to send notifications from.",
953
- "format": "email"
954
- }
955
- }
956
- },
957
- "AutomationImageExport": {
958
- "required": ["requestPayload"],
959
- "type": "object",
960
- "properties": {
961
- "requestPayload": {
962
- "$ref": "#/components/schemas/ImageExportRequest"
963
- }
964
- }
965
- },
966
- "AutomationMetadata": {
967
- "maxLength": 250000,
968
- "type": "object",
969
- "properties": {
970
- "widget": {
971
- "type": "string"
972
- },
973
- "visibleFilters": {
974
- "type": "array",
975
- "items": {
976
- "$ref": "#/components/schemas/VisibleFilter"
977
- }
978
- }
979
- },
980
- "additionalProperties": true,
981
- "description": "Additional information for the automation.",
982
- "nullable": true
983
- },
984
- "AutomationRawExport": {
985
- "required": ["requestPayload"],
986
- "type": "object",
987
- "properties": {
988
- "requestPayload": {
989
- "$ref": "#/components/schemas/RawExportAutomationRequest"
990
- }
991
- }
992
- },
993
- "AutomationSlidesExport": {
994
- "required": ["requestPayload"],
995
- "type": "object",
996
- "properties": {
997
- "requestPayload": {
998
- "$ref": "#/components/schemas/SlidesExportRequest"
999
- }
1000
- }
1001
- },
1002
- "AutomationTabularExport": {
1003
- "required": ["requestPayload"],
1004
- "type": "object",
1005
- "properties": {
1006
- "requestPayload": {
1007
- "$ref": "#/components/schemas/TabularExportRequest"
1008
- }
1009
- }
1010
- },
1011
- "AutomationVisualExport": {
1012
- "required": ["requestPayload"],
1013
- "type": "object",
1014
- "properties": {
1015
- "requestPayload": {
1016
- "$ref": "#/components/schemas/VisualExportRequest"
1017
- }
1018
- }
1019
- },
1020
- "BoundedFilter": {
1021
- "required": ["granularity"],
1022
- "type": "object",
1023
- "properties": {
1024
- "granularity": {
1025
- "type": "string",
1026
- "description": "Date granularity specifying particular date attribute in given dimension.",
1027
- "example": "DAY",
1028
- "enum": [
1029
- "MINUTE",
1030
- "HOUR",
1031
- "DAY",
1032
- "WEEK",
1033
- "MONTH",
1034
- "QUARTER",
1035
- "YEAR",
1036
- "MINUTE_OF_HOUR",
1037
- "HOUR_OF_DAY",
1038
- "DAY_OF_WEEK",
1039
- "DAY_OF_MONTH",
1040
- "DAY_OF_QUARTER",
1041
- "DAY_OF_YEAR",
1042
- "WEEK_OF_YEAR",
1043
- "MONTH_OF_YEAR",
1044
- "QUARTER_OF_YEAR",
1045
- "FISCAL_MONTH",
1046
- "FISCAL_QUARTER",
1047
- "FISCAL_YEAR"
1048
- ]
1049
- },
1050
- "from": {
1051
- "type": "integer",
1052
- "description": "Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago'). If null, then start of the range is unbounded.",
1053
- "format": "int32",
1054
- "nullable": true,
1055
- "example": -6
1056
- },
1057
- "to": {
1058
- "type": "integer",
1059
- "description": "End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...). If null, then end of the range is unbounded.",
1060
- "format": "int32",
1061
- "nullable": true,
1062
- "example": 0
1063
- }
1064
- },
1065
- "description": "Bounding filter for this relative date filter. This can be used to limit the range of the relative date filter to a specific date range."
1066
- },
1067
- "Comparison": {
1068
- "required": ["left", "operator", "right"],
1069
- "type": "object",
1070
- "properties": {
1071
- "operator": {
1072
- "type": "string",
1073
- "enum": [
1074
- "GREATER_THAN",
1075
- "GREATER_THAN_OR_EQUAL_TO",
1076
- "LESS_THAN",
1077
- "LESS_THAN_OR_EQUAL_TO",
1078
- "EQUAL_TO",
1079
- "NOT_EQUAL_TO"
1080
- ]
1081
- },
1082
- "left": {
1083
- "$ref": "#/components/schemas/LocalIdentifier"
1084
- },
1085
- "right": {
1086
- "$ref": "#/components/schemas/AlertConditionOperand"
1087
- }
1088
- }
1089
- },
1090
- "ComparisonMeasureValueFilter": {
1091
- "required": ["comparisonMeasureValueFilter"],
1092
- "type": "object",
1093
- "properties": {
1094
- "comparisonMeasureValueFilter": {
1095
- "required": ["operator", "value", "measure"],
1096
- "type": "object",
1097
- "properties": {
1098
- "dimensionality": {
1099
- "type": "array",
1100
- "description": "References to the attributes to be used when filtering.",
1101
- "items": {
1102
- "$ref": "#/components/schemas/AfmIdentifier"
1103
- }
1104
- },
1105
- "treatNullValuesAs": {
1106
- "type": "number",
1107
- "description": "A value that will be substituted for null values in the metric for the comparisons.",
1108
- "example": 0
1109
- },
1110
- "operator": {
1111
- "type": "string",
1112
- "example": "GREATER_THAN",
1113
- "enum": [
1114
- "GREATER_THAN",
1115
- "GREATER_THAN_OR_EQUAL_TO",
1116
- "LESS_THAN",
1117
- "LESS_THAN_OR_EQUAL_TO",
1118
- "EQUAL_TO",
1119
- "NOT_EQUAL_TO"
1120
- ]
1121
- },
1122
- "value": {
1123
- "type": "number",
1124
- "example": 1327
1125
- },
1126
- "localIdentifier": {
1127
- "type": "string"
1128
- },
1129
- "applyOnResult": {
1130
- "type": "boolean"
1131
- },
1132
- "measure": {
1133
- "$ref": "#/components/schemas/AfmIdentifier"
1134
- }
1135
- }
1136
- }
1137
- },
1138
- "description": "Filter the result by comparing specified metric to given constant value, using given comparison operator."
1139
- },
1140
- "ComparisonWrapper": {
1141
- "required": ["comparison"],
1142
- "type": "object",
1143
- "properties": {
1144
- "comparison": {
1145
- "$ref": "#/components/schemas/Comparison"
1146
- }
1147
- }
1148
- },
1149
- "CustomLabel": {
1150
- "required": ["title"],
1151
- "type": "object",
1152
- "properties": {
1153
- "title": {
1154
- "type": "string",
1155
- "description": "Override value."
1156
- }
1157
- },
1158
- "description": "Custom label object override."
1159
- },
1160
- "CustomMetric": {
1161
- "required": ["format", "title"],
1162
- "type": "object",
1163
- "properties": {
1164
- "title": {
1165
- "type": "string",
1166
- "description": "Metric title override."
1167
- },
1168
- "format": {
1169
- "type": "string",
1170
- "description": "Format override."
1171
- }
1172
- },
1173
- "description": "Custom metric object override."
1174
- },
1175
- "CustomOverride": {
1176
- "type": "object",
1177
- "properties": {
1178
- "labels": {
1179
- "type": "object",
1180
- "additionalProperties": {
1181
- "$ref": "#/components/schemas/CustomLabel"
1182
- },
1183
- "description": "Map of CustomLabels with keys used as placeholders in document."
1184
- },
1185
- "metrics": {
1186
- "type": "object",
1187
- "additionalProperties": {
1188
- "$ref": "#/components/schemas/CustomMetric"
1189
- },
1190
- "description": "Map of CustomMetrics with keys used as placeholders in document."
1191
- }
1192
- },
1193
- "description": "Custom cell value overrides (IDs will be replaced with specified values)."
1194
- },
1195
- "DashboardAttributeFilter": {
1196
- "required": ["attributeFilter"],
1197
- "type": "object",
1198
- "properties": {
1199
- "attributeFilter": {
1200
- "required": ["attributeElements", "displayForm", "negativeSelection"],
1201
- "type": "object",
1202
- "properties": {
1203
- "displayForm": {
1204
- "$ref": "#/components/schemas/IdentifierRef"
1205
- },
1206
- "negativeSelection": {
1207
- "type": "boolean"
1208
- },
1209
- "attributeElements": {
1210
- "$ref": "#/components/schemas/AttributeElements"
1211
- },
1212
- "filterElementsBy": {
1213
- "type": "array",
1214
- "items": {
1215
- "$ref": "#/components/schemas/AttributeFilterParent"
1216
- }
1217
- },
1218
- "filterElementsByDate": {
1219
- "type": "array",
1220
- "items": {
1221
- "$ref": "#/components/schemas/AttributeFilterByDate"
1222
- }
1223
- },
1224
- "validateElementsBy": {
1225
- "type": "array",
1226
- "items": {
1227
- "$ref": "#/components/schemas/IdentifierRef"
1228
- }
1229
- },
1230
- "title": {
1231
- "type": "string"
1232
- },
1233
- "selectionMode": {
1234
- "type": "string",
1235
- "enum": ["single", "multi"]
1236
- },
1237
- "localIdentifier": {
1238
- "type": "string"
1239
- }
1240
- }
1241
- }
1242
- }
1243
- },
1244
- "DashboardDateFilter": {
1245
- "required": ["dateFilter"],
1246
- "type": "object",
1247
- "properties": {
1248
- "dateFilter": {
1249
- "required": ["granularity", "type"],
1250
- "type": "object",
1251
- "properties": {
1252
- "type": {
1253
- "type": "string",
1254
- "enum": ["relative", "absolute"]
1255
- },
1256
- "granularity": {
1257
- "type": "string",
1258
- "enum": [
1259
- "ALL_TIME_GRANULARITY",
1260
- "GDC.time.year",
1261
- "GDC.time.week_us",
1262
- "GDC.time.week_in_year",
1263
- "GDC.time.week_in_quarter",
1264
- "GDC.time.week",
1265
- "GDC.time.euweek_in_year",
1266
- "GDC.time.euweek_in_quarter",
1267
- "GDC.time.quarter",
1268
- "GDC.time.quarter_in_year",
1269
- "GDC.time.month",
1270
- "GDC.time.month_in_quarter",
1271
- "GDC.time.month_in_year",
1272
- "GDC.time.day_in_year",
1273
- "GDC.time.day_in_quarter",
1274
- "GDC.time.day_in_month",
1275
- "GDC.time.day_in_week",
1276
- "GDC.time.day_in_euweek",
1277
- "GDC.time.date",
1278
- "GDC.time.hour",
1279
- "GDC.time.hour_in_day",
1280
- "GDC.time.minute",
1281
- "GDC.time.minute_in_hour",
1282
- "GDC.time.fiscal_month",
1283
- "GDC.time.fiscal_quarter",
1284
- "GDC.time.fiscal_year"
1285
- ]
1286
- },
1287
- "from": {
1288
- "oneOf": [
1289
- {
1290
- "type": "string"
1291
- },
1292
- {
1293
- "type": "integer",
1294
- "format": "int32"
1295
- }
1296
- ]
1297
- },
1298
- "to": {
1299
- "oneOf": [
1300
- {
1301
- "type": "string"
1302
- },
1303
- {
1304
- "type": "integer",
1305
- "format": "int32"
1306
- }
1307
- ]
1308
- },
1309
- "dataSet": {
1310
- "$ref": "#/components/schemas/IdentifierRef"
1311
- },
1312
- "attribute": {
1313
- "$ref": "#/components/schemas/IdentifierRef"
1314
- },
1315
- "boundedFilter": {
1316
- "$ref": "#/components/schemas/RelativeBoundedDateFilter"
1317
- },
1318
- "localIdentifier": {
1319
- "type": "string"
1320
- }
1321
- }
1322
- }
1323
- }
1324
- },
1325
- "DashboardExportSettings": {
1326
- "type": "object",
1327
- "properties": {
1328
- "exportInfo": {
1329
- "type": "boolean",
1330
- "description": "If true, the export will contain the information about the export – exported date, dashboard filters, etc.",
1331
- "example": true,
1332
- "default": false
1333
- },
1334
- "mergeHeaders": {
1335
- "type": "boolean",
1336
- "description": "Merge equal headers in neighbouring cells. Used for [XLSX] format only.",
1337
- "example": true,
1338
- "default": false
1339
- },
1340
- "pageSize": {
1341
- "type": "string",
1342
- "description": "Set page size. (PDF)",
1343
- "default": "A4",
1344
- "enum": ["A3", "A4", "LETTER"]
1345
- },
1346
- "pageOrientation": {
1347
- "type": "string",
1348
- "description": "Set page orientation. (PDF)",
1349
- "default": "PORTRAIT",
1350
- "enum": ["PORTRAIT", "LANDSCAPE"]
1351
- }
1352
- },
1353
- "description": "Additional settings."
1354
- },
1355
- "DashboardFilter": {
1356
- "type": "object",
1357
- "oneOf": [
1358
- {
1359
- "$ref": "#/components/schemas/DashboardAttributeFilter"
1360
- },
1361
- {
1362
- "$ref": "#/components/schemas/DashboardDateFilter"
1363
- }
1364
- ]
1365
- },
1366
- "DashboardTabularExportRequestV2": {
1367
- "required": ["dashboardId", "fileName", "format"],
1368
- "type": "object",
1369
- "properties": {
1370
- "format": {
1371
- "type": "string",
1372
- "description": "Requested tabular export type.",
1373
- "example": "XLSX",
1374
- "enum": ["XLSX", "PDF"]
1375
- },
1376
- "fileName": {
1377
- "type": "string",
1378
- "description": "Filename of downloaded file without extension.",
1379
- "example": "result"
1380
- },
1381
- "dashboardFiltersOverride": {
1382
- "type": "array",
1383
- "description": "List of filters that will be used instead of the default dashboard filters.",
1384
- "items": {
1385
- "$ref": "#/components/schemas/DashboardFilter"
1386
- }
1387
- },
1388
- "dashboardTabsFiltersOverrides": {
1389
- "type": "object",
1390
- "additionalProperties": {
1391
- "type": "array",
1392
- "items": {
1393
- "$ref": "#/components/schemas/DashboardFilter"
1394
- }
1395
- },
1396
- "description": "Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab."
1397
- },
1398
- "dashboardId": {
1399
- "type": "string",
1400
- "description": "Dashboard identifier",
1401
- "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0"
1402
- },
1403
- "widgetIds": {
1404
- "maxItems": 1,
1405
- "uniqueItems": true,
1406
- "type": "array",
1407
- "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.",
1408
- "items": {
1409
- "type": "string"
1410
- }
1411
- },
1412
- "settings": {
1413
- "$ref": "#/components/schemas/DashboardExportSettings"
1414
- }
1415
- },
1416
- "description": "Export request object describing the export properties for dashboard tabular exports (v2 with dashboardId)."
1417
- },
1418
- "DateFilter": {
1419
- "type": "object",
1420
- "description": "Abstract filter definition type for dates.",
1421
- "oneOf": [
1422
- {
1423
- "$ref": "#/components/schemas/AbsoluteDateFilter"
1424
- },
1425
- {
1426
- "$ref": "#/components/schemas/RelativeDateFilter"
1427
- }
1428
- ]
1429
- },
1430
- "DateValue": {
1431
- "required": ["value"],
1432
- "type": "object",
1433
- "properties": {
1434
- "value": {
1435
- "type": "string"
1436
- }
1437
- }
1438
- },
1439
- "DeclarativeAnalyticalDashboardIdentifier": {
1440
- "required": ["id", "type"],
1441
- "type": "object",
1442
- "properties": {
1443
- "id": {
1444
- "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
1445
- "type": "string",
1446
- "description": "Identifier of the analytical dashboard.",
1447
- "example": "dashboard123"
1448
- },
1449
- "type": {
1450
- "type": "string",
1451
- "description": "A type.",
1452
- "example": "analyticalDashboard",
1453
- "enum": ["analyticalDashboard"]
1454
- }
1455
- },
1456
- "description": "An analytical dashboard identifier."
1457
- },
1458
- "DeclarativeNotificationChannelIdentifier": {
1459
- "required": ["id", "type"],
1460
- "type": "object",
1461
- "properties": {
1462
- "id": {
1463
- "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
1464
- "type": "string",
1465
- "description": "Notification channel identifier.",
1466
- "example": "webhook123"
1467
- },
1468
- "type": {
1469
- "type": "string",
1470
- "description": "A type.",
1471
- "example": "notificationChannel",
1472
- "enum": ["notificationChannel"]
1473
- }
1474
- },
1475
- "description": "A notification channel identifier."
1476
- },
1477
- "DeclarativeUserIdentifier": {
1478
- "required": ["id", "type"],
1479
- "type": "object",
1480
- "properties": {
1481
- "id": {
1482
- "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
1483
- "type": "string",
1484
- "description": "User identifier.",
1485
- "example": "employee123"
1486
- },
1487
- "type": {
1488
- "type": "string",
1489
- "description": "A type.",
1490
- "example": "user",
1491
- "enum": ["user"]
1492
- }
1493
- },
1494
- "description": "A user identifier."
1495
- },
1496
- "ExecutionSettings": {
1497
- "type": "object",
1498
- "properties": {
1499
- "dataSamplingPercentage": {
1500
- "maximum": 100,
1501
- "exclusiveMaximum": true,
1502
- "minimum": 0,
1503
- "exclusiveMinimum": true,
1504
- "type": "number",
1505
- "description": "Specifies the percentage of rows from fact datasets to use during computation. This feature is available only for workspaces that use a Vertica Data Source without table views.",
1506
- "format": "float"
1507
- },
1508
- "timestamp": {
1509
- "type": "string",
1510
- "description": "Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.",
1511
- "format": "date-time"
1512
- }
1513
- },
1514
- "description": "Various settings affecting the process of AFM execution or its result"
1515
- },
1516
- "FilterDefinition": {
1517
- "type": "object",
1518
- "description": "Abstract filter definition type",
1519
- "oneOf": [
1520
- {
1521
- "$ref": "#/components/schemas/InlineFilterDefinition"
1522
- },
1523
- {
1524
- "$ref": "#/components/schemas/RankingFilter"
1525
- },
1526
- {
1527
- "$ref": "#/components/schemas/ComparisonMeasureValueFilter"
1528
- },
1529
- {
1530
- "$ref": "#/components/schemas/RangeMeasureValueFilter"
1531
- },
1532
- {
1533
- "$ref": "#/components/schemas/AbsoluteDateFilter"
1534
- },
1535
- {
1536
- "$ref": "#/components/schemas/RelativeDateFilter"
1537
- },
1538
- {
1539
- "$ref": "#/components/schemas/NegativeAttributeFilter"
1540
- },
1541
- {
1542
- "$ref": "#/components/schemas/PositiveAttributeFilter"
1543
- }
1544
- ]
1545
- },
1546
- "FilterDefinitionForSimpleMeasure": {
1547
- "type": "object",
1548
- "description": "Abstract filter definition type for simple metric.",
1549
- "oneOf": [
1550
- {
1551
- "$ref": "#/components/schemas/DateFilter"
1552
- },
1553
- {
1554
- "$ref": "#/components/schemas/AttributeFilter"
1555
- }
1556
- ]
1557
- },
1558
- "IdentifierRef": {
1559
- "type": "object",
1560
- "properties": {
1561
- "identifier": {
1562
- "required": ["id", "type"],
1563
- "type": "object",
1564
- "properties": {
1565
- "id": {
1566
- "type": "string"
1567
- },
1568
- "type": {
1569
- "type": "string",
1570
- "enum": [
1571
- "analyticalDashboard",
1572
- "attribute",
1573
- "attributeHierarchy",
1574
- "dashboardPlugin",
1575
- "dataset",
1576
- "fact",
1577
- "aggregatedFact",
1578
- "label",
1579
- "metric",
1580
- "userDataFilter",
1581
- "exportDefinition",
1582
- "automation",
1583
- "automationResult",
1584
- "memoryItem",
1585
- "knowledgeRecommendation",
1586
- "prompt",
1587
- "visualizationObject",
1588
- "filterContext",
1589
- "workspaceSettings",
1590
- "customApplicationSetting",
1591
- "workspaceDataFilter",
1592
- "workspaceDataFilterSetting",
1593
- "filterView"
1594
- ]
1595
- }
1596
- }
1597
- }
1598
- }
1599
- },
1600
- "ImageExportRequest": {
1601
- "required": ["dashboardId", "fileName", "format", "widgetIds"],
1602
- "type": "object",
1603
- "properties": {
1604
- "format": {
1605
- "type": "string",
1606
- "description": "Requested resulting file type.",
1607
- "example": "PNG",
1608
- "enum": ["PNG"]
1609
- },
1610
- "fileName": {
1611
- "type": "string",
1612
- "description": "File name to be used for retrieving the image document.",
1613
- "example": "filename"
1614
- },
1615
- "dashboardId": {
1616
- "type": "string",
1617
- "description": "Dashboard identifier",
1618
- "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0"
1619
- },
1620
- "widgetIds": {
1621
- "maxItems": 1,
1622
- "minItems": 1,
1623
- "uniqueItems": true,
1624
- "type": "array",
1625
- "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.",
1626
- "items": {
1627
- "maxLength": 255,
1628
- "minLength": 1,
1629
- "type": "string"
1630
- }
1631
- },
1632
- "metadata": {
1633
- "$ref": "#/components/schemas/JsonNode"
1634
- }
1635
- },
1636
- "description": "Export request object describing the export properties and metadata for image exports."
1637
- },
1638
- "InlineFilterDefinition": {
1639
- "required": ["inline"],
1640
- "type": "object",
1641
- "properties": {
1642
- "inline": {
1643
- "required": ["filter"],
1644
- "type": "object",
1645
- "properties": {
1646
- "filter": {
1647
- "type": "string",
1648
- "description": "MAQL query representing the filter."
1649
- },
1650
- "localIdentifier": {
1651
- "type": "string"
1652
- },
1653
- "applyOnResult": {
1654
- "type": "boolean"
1655
- }
1656
- }
1657
- }
1658
- },
1659
- "description": "Filter in form of direct MAQL query."
1660
- },
1661
- "InlineMeasureDefinition": {
1662
- "required": ["inline"],
1663
- "type": "object",
1664
- "properties": {
1665
- "inline": {
1666
- "required": ["maql"],
1667
- "type": "object",
1668
- "properties": {
1669
- "maql": {
1670
- "type": "string",
1671
- "description": "MAQL query defining the metric."
1672
- }
1673
- }
1674
- }
1675
- },
1676
- "description": "Metric defined by the raw MAQL query."
1677
- },
1678
- "JsonNode": {
1679
- "maxLength": 15000,
1680
- "type": "object",
1681
- "description": "Metadata definition in free-form JSON format.",
1682
- "nullable": true,
1683
- "example": {}
1684
- },
1685
- "LocalIdentifier": {
1686
- "required": ["localIdentifier"],
1687
- "type": "object",
1688
- "properties": {
1689
- "localIdentifier": {
1690
- "type": "string",
1691
- "description": "Local identifier of the metric to be compared.",
1692
- "example": "m1"
1693
- },
1694
- "format": {
1695
- "maxLength": 2048,
1696
- "type": "string",
1697
- "description": "Metric format.",
1698
- "nullable": true,
1699
- "example": "#,##0",
1700
- "default": "#,##0.00"
1701
- },
1702
- "title": {
1703
- "maxLength": 255,
1704
- "type": "string",
1705
- "description": "Metric title.",
1706
- "nullable": true,
1707
- "example": "Revenue"
1708
- }
1709
- }
1710
- },
1711
- "MeasureDefinition": {
1712
- "type": "object",
1713
- "description": "Abstract metric definition type",
1714
- "oneOf": [
1715
- {
1716
- "$ref": "#/components/schemas/InlineMeasureDefinition"
1717
- },
1718
- {
1719
- "$ref": "#/components/schemas/ArithmeticMeasureDefinition"
1720
- },
1721
- {
1722
- "$ref": "#/components/schemas/SimpleMeasureDefinition"
1723
- },
1724
- {
1725
- "$ref": "#/components/schemas/PopMeasureDefinition"
1726
- }
1727
- ]
1728
- },
1729
- "MeasureItem": {
1730
- "required": ["definition", "localIdentifier"],
1731
- "type": "object",
1732
- "properties": {
1733
- "localIdentifier": {
1734
- "pattern": "^[.a-zA-Z0-9_-]+$",
1735
- "type": "string",
1736
- "description": "Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.",
1737
- "example": "metric_1"
1738
- },
1739
- "definition": {
1740
- "oneOf": [
1741
- {
1742
- "$ref": "#/components/schemas/ArithmeticMeasureDefinition"
1743
- },
1744
- {
1745
- "$ref": "#/components/schemas/InlineMeasureDefinition"
1746
- },
1747
- {
1748
- "$ref": "#/components/schemas/PopDatasetMeasureDefinition"
1749
- },
1750
- {
1751
- "$ref": "#/components/schemas/PopDateMeasureDefinition"
1752
- },
1753
- {
1754
- "$ref": "#/components/schemas/PopMeasureDefinition"
1755
- },
1756
- {
1757
- "$ref": "#/components/schemas/SimpleMeasureDefinition"
1758
- }
1759
- ]
1760
- }
1761
- },
1762
- "description": "Metric is a quantity that is calculated from the data."
1763
- },
1764
- "MeasureValueFilter": {
1765
- "type": "object",
1766
- "description": "Abstract filter definition type filtering by the value of the metric.",
1767
- "oneOf": [
1768
- {
1769
- "$ref": "#/components/schemas/ComparisonMeasureValueFilter"
1770
- },
1771
- {
1772
- "$ref": "#/components/schemas/RangeMeasureValueFilter"
1773
- }
1774
- ]
1775
- },
1776
- "NegativeAttributeFilter": {
1777
- "required": ["negativeAttributeFilter"],
1778
- "type": "object",
1779
- "properties": {
1780
- "negativeAttributeFilter": {
1781
- "required": ["notIn", "label"],
1782
- "type": "object",
1783
- "properties": {
1784
- "notIn": {
1785
- "$ref": "#/components/schemas/AttributeFilterElements"
1786
- },
1787
- "localIdentifier": {
1788
- "type": "string"
1789
- },
1790
- "applyOnResult": {
1791
- "type": "boolean"
1792
- },
1793
- "label": {
1794
- "$ref": "#/components/schemas/AfmIdentifier"
1795
- }
1796
- }
1797
- }
1798
- },
1799
- "description": "Filter able to limit element values by label and related selected negated elements."
1800
- },
1801
- "Over": {
1802
- "required": ["attributes"],
1803
- "type": "object",
1804
- "properties": {
1805
- "attributes": {
1806
- "type": "array",
1807
- "items": {
1808
- "$ref": "#/components/schemas/IdentifierRef"
1809
- }
1810
- }
1811
- }
1812
- },
1813
- "PdfTableStyle": {
1814
- "required": ["selector"],
1815
- "type": "object",
1816
- "properties": {
1817
- "selector": {
1818
- "type": "string",
1819
- "description": "CSS selector where to apply given properties."
1820
- },
1821
- "properties": {
1822
- "type": "array",
1823
- "description": "List of CSS properties.",
1824
- "items": {
1825
- "$ref": "#/components/schemas/PdfTableStyleProperty"
1826
- }
1827
- }
1828
- },
1829
- "description": "Custom CSS styles for the table. (PDF, HTML)",
1830
- "example": [
1831
- {
1832
- "selector": "th",
1833
- "properties": [
1834
- {
1835
- "key": "font-size",
1836
- "value": "30px"
1837
- }
1838
- ]
1839
- }
1840
- ],
1841
- "deprecated": true
1842
- },
1843
- "PdfTableStyleProperty": {
1844
- "required": ["key", "value"],
1845
- "type": "object",
1846
- "properties": {
1847
- "key": {
1848
- "type": "string",
1849
- "description": "CSS property key."
1850
- },
1851
- "value": {
1852
- "type": "string",
1853
- "description": "CSS property value."
1854
- }
1855
- },
1856
- "description": "CSS property."
1857
- },
1858
- "PopDataset": {
1859
- "required": ["dataset", "periodsAgo"],
1860
- "type": "object",
1861
- "properties": {
1862
- "dataset": {
1863
- "$ref": "#/components/schemas/AfmObjectIdentifierDataset"
1864
- },
1865
- "periodsAgo": {
1866
- "type": "integer",
1867
- "description": "Number of periods ago to calculate the previous period for.",
1868
- "format": "int32",
1869
- "example": 1
1870
- }
1871
- },
1872
- "description": "Combination of the date data set to use and how many periods ago to calculate the previous period for."
1873
- },
1874
- "PopDatasetMeasureDefinition": {
1875
- "required": ["previousPeriodMeasure"],
1876
- "type": "object",
1877
- "properties": {
1878
- "previousPeriodMeasure": {
1879
- "required": ["dateDatasets", "measureIdentifier"],
1880
- "type": "object",
1881
- "properties": {
1882
- "measureIdentifier": {
1883
- "$ref": "#/components/schemas/AfmLocalIdentifier"
1884
- },
1885
- "dateDatasets": {
1886
- "type": "array",
1887
- "description": "Specification of which date data sets to use for determining the period to calculate the previous period for.",
1888
- "items": {
1889
- "$ref": "#/components/schemas/PopDataset"
1890
- }
1891
- }
1892
- }
1893
- }
1894
- },
1895
- "description": "Previous period type of metric."
1896
- },
1897
- "PopDate": {
1898
- "required": ["attribute", "periodsAgo"],
1899
- "type": "object",
1900
- "properties": {
1901
- "attribute": {
1902
- "$ref": "#/components/schemas/AfmObjectIdentifierAttribute"
1903
- },
1904
- "periodsAgo": {
1905
- "type": "integer",
1906
- "description": "Number of periods ago to calculate the previous period for.",
1907
- "format": "int32",
1908
- "example": 1
1909
- }
1910
- },
1911
- "description": "Combination of the date attribute to use and how many periods ago to calculate the PoP for."
1912
- },
1913
- "PopDateMeasureDefinition": {
1914
- "required": ["overPeriodMeasure"],
1915
- "type": "object",
1916
- "properties": {
1917
- "overPeriodMeasure": {
1918
- "required": ["dateAttributes", "measureIdentifier"],
1919
- "type": "object",
1920
- "properties": {
1921
- "measureIdentifier": {
1922
- "$ref": "#/components/schemas/AfmLocalIdentifier"
1923
- },
1924
- "dateAttributes": {
1925
- "type": "array",
1926
- "description": "Attributes to use for determining the period to calculate the PoP for.",
1927
- "items": {
1928
- "$ref": "#/components/schemas/PopDate"
1929
- }
1930
- }
1931
- }
1932
- }
1933
- },
1934
- "description": "Period over period type of metric."
1935
- },
1936
- "PopMeasureDefinition": {
1937
- "type": "object",
1938
- "oneOf": [
1939
- {
1940
- "$ref": "#/components/schemas/PopDatasetMeasureDefinition"
1941
- },
1942
- {
1943
- "$ref": "#/components/schemas/PopDateMeasureDefinition"
1944
- }
1945
- ]
1946
- },
1947
- "PositiveAttributeFilter": {
1948
- "required": ["positiveAttributeFilter"],
1949
- "type": "object",
1950
- "properties": {
1951
- "positiveAttributeFilter": {
1952
- "required": ["in", "label"],
1953
- "type": "object",
1954
- "properties": {
1955
- "in": {
1956
- "$ref": "#/components/schemas/AttributeFilterElements"
1957
- },
1958
- "localIdentifier": {
1959
- "type": "string"
1960
- },
1961
- "applyOnResult": {
1962
- "type": "boolean"
1963
- },
1964
- "label": {
1965
- "$ref": "#/components/schemas/AfmIdentifier"
1966
- }
1967
- }
1968
- }
1969
- },
1970
- "description": "Filter able to limit element values by label and related selected elements."
1971
- },
1972
- "Range": {
1973
- "required": ["from", "measure", "operator", "to"],
1974
- "type": "object",
1975
- "properties": {
1976
- "operator": {
1977
- "type": "string",
1978
- "enum": ["BETWEEN", "NOT_BETWEEN"]
1979
- },
1980
- "measure": {
1981
- "$ref": "#/components/schemas/LocalIdentifier"
1982
- },
1983
- "from": {
1984
- "$ref": "#/components/schemas/Value"
1985
- },
1986
- "to": {
1987
- "$ref": "#/components/schemas/Value"
1988
- }
1989
- }
1990
- },
1991
- "RangeMeasureValueFilter": {
1992
- "required": ["rangeMeasureValueFilter"],
1993
- "type": "object",
1994
- "properties": {
1995
- "rangeMeasureValueFilter": {
1996
- "required": ["from", "operator", "to", "measure"],
1997
- "type": "object",
1998
- "properties": {
1999
- "dimensionality": {
2000
- "type": "array",
2001
- "description": "References to the attributes to be used when filtering.",
2002
- "items": {
2003
- "$ref": "#/components/schemas/AfmIdentifier"
2004
- }
2005
- },
2006
- "treatNullValuesAs": {
2007
- "type": "number",
2008
- "description": "A value that will be substituted for null values in the metric for the comparisons.",
2009
- "example": 0
2010
- },
2011
- "operator": {
2012
- "type": "string",
2013
- "example": "BETWEEN",
2014
- "enum": ["BETWEEN", "NOT_BETWEEN"]
2015
- },
2016
- "from": {
2017
- "type": "number",
2018
- "example": 100
2019
- },
2020
- "to": {
2021
- "type": "number",
2022
- "example": 999
2023
- },
2024
- "localIdentifier": {
2025
- "type": "string"
2026
- },
2027
- "applyOnResult": {
2028
- "type": "boolean"
2029
- },
2030
- "measure": {
2031
- "$ref": "#/components/schemas/AfmIdentifier"
2032
- }
2033
- }
2034
- }
2035
- },
2036
- "description": "Filter the result by comparing specified metric to given range of values."
2037
- },
2038
- "RangeWrapper": {
2039
- "required": ["range"],
2040
- "type": "object",
2041
- "properties": {
2042
- "range": {
2043
- "$ref": "#/components/schemas/Range"
2044
- }
2045
- }
2046
- },
2047
- "RankingFilter": {
2048
- "required": ["rankingFilter"],
2049
- "type": "object",
2050
- "properties": {
2051
- "rankingFilter": {
2052
- "required": ["measures", "operator", "value"],
2053
- "type": "object",
2054
- "properties": {
2055
- "dimensionality": {
2056
- "type": "array",
2057
- "description": "References to the attributes to be used when filtering.",
2058
- "items": {
2059
- "$ref": "#/components/schemas/AfmIdentifier"
2060
- }
2061
- },
2062
- "measures": {
2063
- "type": "array",
2064
- "description": "References to the metrics to be used when filtering.",
2065
- "items": {
2066
- "$ref": "#/components/schemas/AfmIdentifier"
2067
- }
2068
- },
2069
- "operator": {
2070
- "type": "string",
2071
- "description": "The type of ranking to use, TOP or BOTTOM.",
2072
- "enum": ["TOP", "BOTTOM"]
2073
- },
2074
- "value": {
2075
- "type": "integer",
2076
- "description": "Number of top/bottom values to filter.",
2077
- "format": "int32",
2078
- "example": 5
2079
- },
2080
- "localIdentifier": {
2081
- "type": "string"
2082
- },
2083
- "applyOnResult": {
2084
- "type": "boolean"
2085
- }
2086
- }
2087
- }
2088
- },
2089
- "description": "Filter the result on top/bottom N values according to given metric(s)."
2090
- },
2091
- "RawCustomLabel": {
2092
- "required": ["title"],
2093
- "type": "object",
2094
- "properties": {
2095
- "title": {
2096
- "type": "string",
2097
- "description": "Override value."
2098
- }
2099
- },
2100
- "description": "Custom label object override."
2101
- },
2102
- "RawCustomMetric": {
2103
- "required": ["title"],
2104
- "type": "object",
2105
- "properties": {
2106
- "title": {
2107
- "type": "string",
2108
- "description": "Metric title override."
2109
- }
2110
- },
2111
- "description": "Custom metric object override."
2112
- },
2113
- "RawCustomOverride": {
2114
- "type": "object",
2115
- "properties": {
2116
- "labels": {
2117
- "type": "object",
2118
- "additionalProperties": {
2119
- "$ref": "#/components/schemas/RawCustomLabel"
2120
- },
2121
- "description": "Map of CustomLabels with keys used as placeholders in export result."
2122
- },
2123
- "metrics": {
2124
- "type": "object",
2125
- "additionalProperties": {
2126
- "$ref": "#/components/schemas/RawCustomMetric"
2127
- },
2128
- "description": "Map of CustomMetrics with keys used as placeholders in export result."
2129
- }
2130
- },
2131
- "description": "Custom cell value overrides (IDs will be replaced with specified values)."
2132
- },
2133
- "RawExportAutomationRequest": {
2134
- "required": ["execution", "fileName", "format"],
2135
- "type": "object",
2136
- "properties": {
2137
- "format": {
2138
- "type": "string",
2139
- "description": "Requested resulting file type.",
2140
- "example": "CSV",
2141
- "enum": ["ARROW_FILE", "ARROW_STREAM", "CSV"]
2142
- },
2143
- "execution": {
2144
- "$ref": "#/components/schemas/AFM"
2145
- },
2146
- "fileName": {
2147
- "type": "string",
2148
- "description": "Filename of downloaded file without extension.",
2149
- "example": "result"
2150
- },
2151
- "customOverride": {
2152
- "$ref": "#/components/schemas/RawCustomOverride"
2153
- },
2154
- "executionSettings": {
2155
- "$ref": "#/components/schemas/ExecutionSettings"
2156
- },
2157
- "metadata": {
2158
- "$ref": "#/components/schemas/JsonNode"
2159
- }
2160
- },
2161
- "description": "Export request object describing the export properties and overrides for raw exports."
2162
- },
2163
- "Relative": {
2164
- "required": ["measure", "operator", "threshold"],
2165
- "type": "object",
2166
- "properties": {
2167
- "operator": {
2168
- "type": "string",
2169
- "description": "Relative condition operator.\nINCREASES_BY - the metric increases by the specified value.\nDECREASES_BY - the metric decreases by the specified value.\nCHANGES_BY - the metric increases or decreases by the specified value.\n",
2170
- "enum": ["INCREASES_BY", "DECREASES_BY", "CHANGES_BY"]
2171
- },
2172
- "measure": {
2173
- "$ref": "#/components/schemas/ArithmeticMeasure"
2174
- },
2175
- "threshold": {
2176
- "$ref": "#/components/schemas/Value"
2177
- }
2178
- }
2179
- },
2180
- "RelativeBoundedDateFilter": {
2181
- "required": ["granularity"],
2182
- "type": "object",
2183
- "properties": {
2184
- "granularity": {
2185
- "type": "string",
2186
- "enum": [
2187
- "ALL_TIME_GRANULARITY",
2188
- "GDC.time.year",
2189
- "GDC.time.week_us",
2190
- "GDC.time.week_in_year",
2191
- "GDC.time.week_in_quarter",
2192
- "GDC.time.week",
2193
- "GDC.time.euweek_in_year",
2194
- "GDC.time.euweek_in_quarter",
2195
- "GDC.time.quarter",
2196
- "GDC.time.quarter_in_year",
2197
- "GDC.time.month",
2198
- "GDC.time.month_in_quarter",
2199
- "GDC.time.month_in_year",
2200
- "GDC.time.day_in_year",
2201
- "GDC.time.day_in_quarter",
2202
- "GDC.time.day_in_month",
2203
- "GDC.time.day_in_week",
2204
- "GDC.time.day_in_euweek",
2205
- "GDC.time.date",
2206
- "GDC.time.hour",
2207
- "GDC.time.hour_in_day",
2208
- "GDC.time.minute",
2209
- "GDC.time.minute_in_hour",
2210
- "GDC.time.fiscal_month",
2211
- "GDC.time.fiscal_quarter",
2212
- "GDC.time.fiscal_year"
2213
- ]
2214
- },
2215
- "from": {
2216
- "type": "integer",
2217
- "format": "int32"
2218
- },
2219
- "to": {
2220
- "type": "integer",
2221
- "format": "int32"
2222
- }
2223
- }
2224
- },
2225
- "RelativeDateFilter": {
2226
- "required": ["relativeDateFilter"],
2227
- "type": "object",
2228
- "properties": {
2229
- "relativeDateFilter": {
2230
- "required": ["from", "granularity", "to", "dataset"],
2231
- "type": "object",
2232
- "properties": {
2233
- "granularity": {
2234
- "type": "string",
2235
- "description": "Date granularity specifying particular date attribute in given dimension.",
2236
- "example": "DAY",
2237
- "enum": [
2238
- "MINUTE",
2239
- "HOUR",
2240
- "DAY",
2241
- "WEEK",
2242
- "MONTH",
2243
- "QUARTER",
2244
- "YEAR",
2245
- "MINUTE_OF_HOUR",
2246
- "HOUR_OF_DAY",
2247
- "DAY_OF_WEEK",
2248
- "DAY_OF_MONTH",
2249
- "DAY_OF_QUARTER",
2250
- "DAY_OF_YEAR",
2251
- "WEEK_OF_YEAR",
2252
- "MONTH_OF_YEAR",
2253
- "QUARTER_OF_YEAR",
2254
- "FISCAL_MONTH",
2255
- "FISCAL_QUARTER",
2256
- "FISCAL_YEAR"
2257
- ]
2258
- },
2259
- "from": {
2260
- "type": "integer",
2261
- "description": "Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago').",
2262
- "format": "int32",
2263
- "example": -6
2264
- },
2265
- "to": {
2266
- "type": "integer",
2267
- "description": "End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...).",
2268
- "format": "int32",
2269
- "example": 0
2270
- },
2271
- "localIdentifier": {
2272
- "type": "string"
2273
- },
2274
- "applyOnResult": {
2275
- "type": "boolean"
2276
- },
2277
- "boundedFilter": {
2278
- "$ref": "#/components/schemas/BoundedFilter"
2279
- },
2280
- "dataset": {
2281
- "$ref": "#/components/schemas/AfmObjectIdentifierDataset"
2282
- }
2283
- }
2284
- }
2285
- },
2286
- "description": "A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension. The 'from' and 'to' properties mark the boundaries of the interval. If 'from' is omitted, all values earlier than 'to' are included. If 'to' is omitted, all values later than 'from' are included. It is not allowed to omit both."
2287
- },
2288
- "RelativeWrapper": {
2289
- "required": ["relative"],
2290
- "type": "object",
2291
- "properties": {
2292
- "relative": {
2293
- "$ref": "#/components/schemas/Relative"
2294
- }
2295
- }
2296
- },
2297
- "Settings": {
2298
- "type": "object",
2299
- "properties": {
2300
- "exportInfo": {
2301
- "type": "boolean",
2302
- "description": "If true, the export will contain the information about the export – exported date, filters, etc. Works only with `visualizationObject`. (XLSX, PDF)",
2303
- "example": true,
2304
- "default": false
2305
- },
2306
- "mergeHeaders": {
2307
- "type": "boolean",
2308
- "description": "Merge equal headers in neighbouring cells. (XLSX)",
2309
- "example": true
2310
- },
2311
- "showFilters": {
2312
- "type": "boolean",
2313
- "description": "Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)",
2314
- "example": false,
2315
- "deprecated": true
2316
- },
2317
- "pdfPageSize": {
2318
- "type": "string",
2319
- "description": "Page size and orientation. (PDF)",
2320
- "example": "a4 landscape",
2321
- "deprecated": true
2322
- },
2323
- "pdfTableStyle": {
2324
- "type": "array",
2325
- "description": "Custom CSS styles for the table. (PDF, HTML)",
2326
- "example": [
2327
- {
2328
- "selector": "th",
2329
- "properties": [
2330
- {
2331
- "key": "font-size",
2332
- "value": "30px"
2333
- }
2334
- ]
2335
- }
2336
- ],
2337
- "deprecated": true,
2338
- "items": {
2339
- "$ref": "#/components/schemas/PdfTableStyle"
2340
- }
2341
- },
2342
- "pdfTopLeftContent": {
2343
- "type": "string",
2344
- "description": "Top left header content. (PDF)",
2345
- "example": "Good",
2346
- "deprecated": true
2347
- },
2348
- "pdfTopRightContent": {
2349
- "type": "string",
2350
- "description": "Top right header content. (PDF)",
2351
- "example": "Morning",
2352
- "deprecated": true
2353
- },
2354
- "pageSize": {
2355
- "type": "string",
2356
- "description": "Set page size. (PDF)",
2357
- "default": "A4",
2358
- "enum": ["A3", "A4", "LETTER"]
2359
- },
2360
- "pageOrientation": {
2361
- "type": "string",
2362
- "description": "Set page orientation. (PDF)",
2363
- "default": "PORTRAIT",
2364
- "enum": ["PORTRAIT", "LANDSCAPE"]
2365
- }
2366
- },
2367
- "description": "Additional settings."
2368
- },
2369
- "SimpleMeasureDefinition": {
2370
- "required": ["measure"],
2371
- "type": "object",
2372
- "properties": {
2373
- "measure": {
2374
- "required": ["item"],
2375
- "type": "object",
2376
- "properties": {
2377
- "item": {
2378
- "$ref": "#/components/schemas/AfmObjectIdentifierCore"
2379
- },
2380
- "aggregation": {
2381
- "type": "string",
2382
- "description": "Definition of aggregation type of the metric.",
2383
- "example": "SUM",
2384
- "enum": [
2385
- "SUM",
2386
- "COUNT",
2387
- "AVG",
2388
- "MIN",
2389
- "MAX",
2390
- "MEDIAN",
2391
- "RUNSUM",
2392
- "APPROXIMATE_COUNT"
2393
- ]
2394
- },
2395
- "computeRatio": {
2396
- "type": "boolean",
2397
- "description": "If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).",
2398
- "example": true,
2399
- "default": false
2400
- },
2401
- "filters": {
2402
- "type": "array",
2403
- "description": "Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.",
2404
- "items": {
2405
- "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure"
2406
- }
2407
- }
2408
- }
2409
- }
2410
- },
2411
- "description": "Metric defined by referencing a MAQL metric or an LDM fact object with aggregation."
2412
- },
2413
- "SlidesExportRequest": {
2414
- "required": ["fileName", "format"],
2415
- "type": "object",
2416
- "properties": {
2417
- "format": {
2418
- "type": "string",
2419
- "description": "Requested resulting file type.",
2420
- "example": "PDF",
2421
- "enum": ["PDF", "PPTX"]
2422
- },
2423
- "fileName": {
2424
- "type": "string",
2425
- "description": "File name to be used for retrieving the pdf document.",
2426
- "example": "filename"
2427
- },
2428
- "dashboardId": {
2429
- "type": "string",
2430
- "description": "Dashboard identifier",
2431
- "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0"
2432
- },
2433
- "widgetIds": {
2434
- "maxItems": 1,
2435
- "uniqueItems": true,
2436
- "type": "array",
2437
- "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.",
2438
- "items": {
2439
- "maxLength": 255,
2440
- "minLength": 1,
2441
- "type": "string"
2442
- }
2443
- },
2444
- "visualizationIds": {
2445
- "maxItems": 1,
2446
- "uniqueItems": true,
2447
- "type": "array",
2448
- "description": "List of visualization ids to be exported. Note that only one visualization is currently supported.",
2449
- "items": {
2450
- "maxLength": 255,
2451
- "minLength": 1,
2452
- "type": "string"
2453
- }
2454
- },
2455
- "metadata": {
2456
- "$ref": "#/components/schemas/JsonNode"
2457
- },
2458
- "templateId": {
2459
- "maxLength": 255,
2460
- "type": "string",
2461
- "description": "Export template identifier.",
2462
- "nullable": true
2463
- }
2464
- },
2465
- "description": "Export request object describing the export properties and metadata for slides exports."
2466
- },
2467
- "TabularExportRequest": {
2468
- "required": ["fileName", "format"],
2469
- "type": "object",
2470
- "properties": {
2471
- "format": {
2472
- "type": "string",
2473
- "description": "Expected file format.",
2474
- "example": "CSV",
2475
- "enum": ["CSV", "XLSX", "HTML", "PDF"]
2476
- },
2477
- "executionResult": {
2478
- "type": "string",
2479
- "description": "Execution result identifier.",
2480
- "example": "ff483727196c9dc862c7fd3a5a84df55c96d61a4"
2481
- },
2482
- "fileName": {
2483
- "type": "string",
2484
- "description": "Filename of downloaded file without extension.",
2485
- "example": "result"
2486
- },
2487
- "settings": {
2488
- "$ref": "#/components/schemas/Settings"
2489
- },
2490
- "customOverride": {
2491
- "$ref": "#/components/schemas/CustomOverride"
2492
- },
2493
- "visualizationObject": {
2494
- "type": "string",
2495
- "description": "Visualization object identifier. Alternative to executionResult property.",
2496
- "example": "f7c359bc-c230-4487-b15b-ad9685bcb537"
2497
- },
2498
- "visualizationObjectCustomFilters": {
2499
- "type": "array",
2500
- "description": "Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.",
2501
- "example": "[{\"negativeAttributeFilter\":{\"displayForm\":{\"identifier\":{\"id\":\"products.category\",\"type\":\"label\"}},\"notIn\":{\"values\":[\"Books\"]}}}]",
2502
- "items": {
2503
- "type": "object"
2504
- }
2505
- },
2506
- "relatedDashboardId": {
2507
- "type": "string",
2508
- "description": "Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.",
2509
- "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0"
2510
- },
2511
- "metadata": {
2512
- "$ref": "#/components/schemas/JsonNode"
2513
- }
2514
- },
2515
- "description": "Export request object describing the export properties and overrides for tabular exports."
2516
- },
2517
- "TriggerAutomationRequest": {
2518
- "required": ["automation"],
2519
- "type": "object",
2520
- "properties": {
2521
- "automation": {
2522
- "$ref": "#/components/schemas/AdHocAutomation"
2523
- }
2524
- }
2525
- },
2526
- "Value": {
2527
- "required": ["value"],
2528
- "type": "object",
2529
- "properties": {
2530
- "value": {
2531
- "type": "number",
2532
- "description": "Value of the alert threshold to compare the metric to.",
2533
- "example": 1000
2534
- }
2535
- }
2536
- },
2537
- "VisibleFilter": {
2538
- "type": "object",
2539
- "properties": {
2540
- "localIdentifier": {
2541
- "type": "string"
2542
- },
2543
- "title": {
2544
- "type": "string"
2545
- },
2546
- "isAllTimeDateFilter": {
2547
- "type": "boolean",
2548
- "description": "Indicates if the filter is an all-time date filter. Such a filter is not included in report computation, so there is no filter with the same 'localIdentifier' to be found. In such cases, this flag is used to inform the server to not search for the filter in the definitions and include it anyways.",
2549
- "default": false
2550
- }
2551
- }
2552
- },
2553
- "VisualExportRequest": {
2554
- "required": ["dashboardId", "fileName"],
2555
- "type": "object",
2556
- "properties": {
2557
- "fileName": {
2558
- "type": "string",
2559
- "description": "File name to be used for retrieving the pdf document.",
2560
- "example": "filename"
2561
- },
2562
- "dashboardId": {
2563
- "type": "string",
2564
- "description": "Dashboard identifier",
2565
- "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0"
2566
- },
2567
- "metadata": {
2568
- "type": "object",
2569
- "description": "Metadata definition in free-form JSON format.",
2570
- "example": "{}"
2571
- }
2572
- },
2573
- "description": "Export request object describing the export properties and metadata for dashboard PDF exports."
2574
- },
2575
- "TestResponse": {
2576
- "required": ["successful"],
2577
- "type": "object",
2578
- "properties": {
2579
- "successful": {
2580
- "type": "boolean",
2581
- "description": "A flag indicating whether test passed or not.",
2582
- "example": true
2583
- },
2584
- "error": {
2585
- "type": "string",
2586
- "description": "Field containing more details in case of a failure. Details are available to a privileged user only.",
2587
- "example": "Authentication failed"
2588
- }
2589
- },
2590
- "description": "Response from notification channel testing."
2591
- },
2592
- "DefaultSmtp": {
2593
- "required": ["type"],
2594
- "type": "object",
2595
- "properties": {
2596
- "fromEmail": {
2597
- "type": "string",
2598
- "description": "E-mail address to send notifications from. Currently this does not have any effect. E-mail 'no-reply@gooddata.com' is used instead.",
2599
- "format": "email",
2600
- "default": "no-reply@gooddata.com"
2601
- },
2602
- "fromEmailName": {
2603
- "type": "string",
2604
- "description": "An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name 'GoodData' is used instead.",
2605
- "default": "GoodData"
2606
- },
2607
- "type": {
2608
- "type": "string",
2609
- "description": "The destination type.",
2610
- "enum": ["DEFAULT_SMTP"]
2611
- }
2612
- },
2613
- "description": "Default SMTP destination for notifications."
2614
- },
2615
- "InPlatform": {
2616
- "required": ["type"],
2617
- "type": "object",
2618
- "properties": {
2619
- "type": {
2620
- "type": "string",
2621
- "description": "The destination type.",
2622
- "enum": ["IN_PLATFORM"]
2623
- }
2624
- },
2625
- "description": "In-platform destination for notifications."
2626
- },
2627
- "NotificationChannelDestination": {
2628
- "required": ["type"],
2629
- "type": "object",
2630
- "properties": {
2631
- "type": {
2632
- "type": "string"
2633
- }
2634
- },
2635
- "oneOf": [
2636
- {
2637
- "$ref": "#/components/schemas/Webhook"
2638
- },
2639
- {
2640
- "$ref": "#/components/schemas/Smtp"
2641
- },
2642
- {
2643
- "$ref": "#/components/schemas/DefaultSmtp"
2644
- },
2645
- {
2646
- "$ref": "#/components/schemas/InPlatform"
2647
- }
2648
- ]
2649
- },
2650
- "Smtp": {
2651
- "required": ["type"],
2652
- "type": "object",
2653
- "properties": {
2654
- "fromEmail": {
2655
- "type": "string",
2656
- "description": "E-mail address to send notifications from.",
2657
- "format": "email",
2658
- "default": "no-reply@gooddata.com"
2659
- },
2660
- "fromEmailName": {
2661
- "type": "string",
2662
- "description": "An optional e-mail name to send notifications from.",
2663
- "default": "GoodData"
2664
- },
2665
- "host": {
2666
- "type": "string",
2667
- "description": "The SMTP server address."
2668
- },
2669
- "port": {
2670
- "type": "integer",
2671
- "description": "The SMTP server port.",
2672
- "format": "int32",
2673
- "enum": [25, 465, 587, 2525]
2674
- },
2675
- "username": {
2676
- "type": "string",
2677
- "description": "The SMTP server username."
2678
- },
2679
- "password": {
2680
- "type": "string",
2681
- "description": "The SMTP server password.",
2682
- "writeOnly": true
2683
- },
2684
- "type": {
2685
- "type": "string",
2686
- "description": "The destination type.",
2687
- "enum": ["SMTP"]
2688
- }
2689
- },
2690
- "description": "Custom SMTP destination for notifications. The properties host, port, username, and password are required on create and update"
2691
- },
2692
- "TestDestinationRequest": {
2693
- "required": ["destination"],
2694
- "type": "object",
2695
- "properties": {
2696
- "destination": {
2697
- "oneOf": [
2698
- {
2699
- "$ref": "#/components/schemas/DefaultSmtp"
2700
- },
2701
- {
2702
- "$ref": "#/components/schemas/InPlatform"
2703
- },
2704
- {
2705
- "$ref": "#/components/schemas/Smtp"
2706
- },
2707
- {
2708
- "$ref": "#/components/schemas/Webhook"
2709
- }
2710
- ]
2711
- },
2712
- "externalRecipients": {
2713
- "maxItems": 1,
2714
- "uniqueItems": true,
2715
- "type": "array",
2716
- "description": "External recipients of the test result.",
2717
- "nullable": true,
2718
- "items": {
2719
- "$ref": "#/components/schemas/AutomationExternalRecipient"
2720
- }
2721
- }
2722
- },
2723
- "description": "Request body with notification channel destination to test."
2724
- },
2725
- "Webhook": {
2726
- "required": ["type"],
2727
- "type": "object",
2728
- "properties": {
2729
- "url": {
2730
- "maxLength": 255,
2731
- "pattern": "https?\\://.*",
2732
- "type": "string",
2733
- "description": "The webhook URL.",
2734
- "example": "https://webhook.site/something"
2735
- },
2736
- "token": {
2737
- "maxLength": 10000,
2738
- "type": "string",
2739
- "description": "Bearer token for the webhook.",
2740
- "nullable": true,
2741
- "writeOnly": true,
2742
- "example": "secret"
2743
- },
2744
- "hasToken": {
2745
- "maxLength": 10000,
2746
- "type": "boolean",
2747
- "description": "Flag indicating if webhook has a token.",
2748
- "nullable": true,
2749
- "readOnly": true
2750
- },
2751
- "type": {
2752
- "type": "string",
2753
- "description": "The destination type.",
2754
- "enum": ["WEBHOOK"]
2755
- }
2756
- },
2757
- "description": "Webhook destination for notifications. The property url is required on create and update."
2758
- },
2759
- "AlertDescription": {
2760
- "required": ["condition", "metric"],
2761
- "type": "object",
2762
- "properties": {
2763
- "metric": {
2764
- "type": "string"
2765
- },
2766
- "condition": {
2767
- "type": "string"
2768
- },
2769
- "currentValues": {
2770
- "type": "array",
2771
- "items": {
2772
- "$ref": "#/components/schemas/AlertEvaluationRow"
2773
- }
2774
- },
2775
- "attribute": {
2776
- "type": "string"
2777
- },
2778
- "totalValueCount": {
2779
- "type": "integer",
2780
- "format": "int32"
2781
- },
2782
- "triggeredCount": {
2783
- "type": "integer",
2784
- "format": "int32"
2785
- },
2786
- "triggeredAt": {
2787
- "type": "string",
2788
- "format": "date-time"
2789
- },
2790
- "threshold": {
2791
- "type": "number",
2792
- "format": "double"
2793
- },
2794
- "formattedThreshold": {
2795
- "type": "string"
2796
- },
2797
- "lowerThreshold": {
2798
- "type": "number",
2799
- "format": "double"
2800
- },
2801
- "upperThreshold": {
2802
- "type": "number",
2803
- "format": "double"
2804
- },
2805
- "remainingAlertEvaluationCount": {
2806
- "type": "integer",
2807
- "format": "int32"
2808
- },
2809
- "status": {
2810
- "type": "string",
2811
- "enum": ["SUCCESS", "ERROR", "INTERNAL_ERROR", "TIMEOUT"]
2812
- },
2813
- "errorMessage": {
2814
- "type": "string"
2815
- },
2816
- "traceId": {
2817
- "type": "string"
2818
- }
2819
- }
2820
- },
2821
- "AlertEvaluationRow": {
2822
- "type": "object",
2823
- "properties": {
2824
- "primaryMetric": {
2825
- "$ref": "#/components/schemas/MetricRecord"
2826
- },
2827
- "secondaryMetric": {
2828
- "$ref": "#/components/schemas/MetricRecord"
2829
- },
2830
- "computedMetric": {
2831
- "$ref": "#/components/schemas/MetricRecord"
2832
- },
2833
- "labelValue": {
2834
- "type": "string"
2835
- }
2836
- }
2837
- },
2838
- "AutomationNotification": {
2839
- "required": ["content"],
2840
- "type": "object",
2841
- "allOf": [
2842
- {
2843
- "$ref": "#/components/schemas/NotificationContent"
2844
- },
2845
- {
2846
- "type": "object",
2847
- "properties": {
2848
- "content": {
2849
- "$ref": "#/components/schemas/WebhookMessage"
2850
- }
2851
- }
2852
- }
2853
- ]
2854
- },
2855
- "ExportResult": {
2856
- "required": ["exportId", "fileName", "status"],
2857
- "type": "object",
2858
- "properties": {
2859
- "fileName": {
2860
- "type": "string"
2861
- },
2862
- "exportId": {
2863
- "type": "string"
2864
- },
2865
- "status": {
2866
- "type": "string",
2867
- "enum": ["SUCCESS", "ERROR", "INTERNAL_ERROR", "TIMEOUT"]
2868
- },
2869
- "fileUri": {
2870
- "type": "string"
2871
- },
2872
- "expiresAt": {
2873
- "type": "string",
2874
- "format": "date-time"
2875
- },
2876
- "fileSize": {
2877
- "type": "integer",
2878
- "format": "int64"
2879
- },
2880
- "errorMessage": {
2881
- "type": "string"
2882
- },
2883
- "traceId": {
2884
- "type": "string"
2885
- },
2886
- "triggeredAt": {
2887
- "type": "string",
2888
- "format": "date-time"
2889
- }
2890
- }
2891
- },
2892
- "MetricRecord": {
2893
- "required": ["value"],
2894
- "type": "object",
2895
- "properties": {
2896
- "value": {
2897
- "type": "number",
2898
- "format": "double"
2899
- },
2900
- "formattedValue": {
2901
- "type": "string"
2902
- }
2903
- }
2904
- },
2905
- "Notification": {
2906
- "required": ["createdAt", "data", "id", "isRead"],
2907
- "type": "object",
2908
- "properties": {
2909
- "id": {
2910
- "type": "string"
2911
- },
2912
- "workspaceId": {
2913
- "type": "string"
2914
- },
2915
- "automationId": {
2916
- "type": "string"
2917
- },
2918
- "data": {
2919
- "oneOf": [
2920
- {
2921
- "$ref": "#/components/schemas/AutomationNotification"
2922
- },
2923
- {
2924
- "$ref": "#/components/schemas/TestNotification"
2925
- }
2926
- ]
2927
- },
2928
- "isRead": {
2929
- "type": "boolean"
2930
- },
2931
- "createdAt": {
2932
- "type": "string",
2933
- "format": "date-time"
2934
- }
2935
- }
2936
- },
2937
- "NotificationContent": {
2938
- "required": ["type"],
2939
- "type": "object",
2940
- "properties": {
2941
- "type": {
2942
- "type": "string"
2943
- }
2944
- },
2945
- "discriminator": {
2946
- "propertyName": "type",
2947
- "mapping": {
2948
- "AUTOMATION": "#/components/schemas/AutomationNotification",
2949
- "TEST": "#/components/schemas/TestNotification"
2950
- }
2951
- }
2952
- },
2953
- "NotificationFilter": {
2954
- "required": ["filter", "title"],
2955
- "type": "object",
2956
- "properties": {
2957
- "title": {
2958
- "type": "string"
2959
- },
2960
- "filter": {
2961
- "type": "string"
2962
- }
2963
- }
2964
- },
2965
- "Notifications": {
2966
- "required": ["data", "meta"],
2967
- "type": "object",
2968
- "properties": {
2969
- "data": {
2970
- "type": "array",
2971
- "items": {
2972
- "$ref": "#/components/schemas/Notification"
2973
- }
2974
- },
2975
- "meta": {
2976
- "$ref": "#/components/schemas/NotificationsMeta"
2977
- }
2978
- }
2979
- },
2980
- "NotificationsMeta": {
2981
- "type": "object",
2982
- "properties": {
2983
- "total": {
2984
- "$ref": "#/components/schemas/NotificationsMetaTotal"
2985
- }
2986
- }
2987
- },
2988
- "NotificationsMetaTotal": {
2989
- "required": ["all", "unread"],
2990
- "type": "object",
2991
- "properties": {
2992
- "unread": {
2993
- "type": "integer",
2994
- "format": "int64"
2995
- },
2996
- "all": {
2997
- "type": "integer",
2998
- "format": "int64"
2999
- }
3000
- }
3001
- },
3002
- "TestNotification": {
3003
- "required": ["message"],
3004
- "type": "object",
3005
- "allOf": [
3006
- {
3007
- "$ref": "#/components/schemas/NotificationContent"
3008
- },
3009
- {
3010
- "type": "object",
3011
- "properties": {
3012
- "message": {
3013
- "type": "string"
3014
- }
3015
- }
3016
- }
3017
- ]
3018
- },
3019
- "WebhookAutomationInfo": {
3020
- "required": ["dashboardURL", "id", "isCustomDashboardURL"],
3021
- "type": "object",
3022
- "properties": {
3023
- "id": {
3024
- "type": "string"
3025
- },
3026
- "title": {
3027
- "type": "string"
3028
- },
3029
- "dashboardTitle": {
3030
- "type": "string"
3031
- },
3032
- "dashboardURL": {
3033
- "type": "string"
3034
- },
3035
- "isCustomDashboardURL": {
3036
- "type": "boolean"
3037
- }
3038
- }
3039
- },
3040
- "WebhookMessage": {
3041
- "required": ["data", "timestamp", "type"],
3042
- "type": "object",
3043
- "properties": {
3044
- "timestamp": {
3045
- "type": "string",
3046
- "format": "date-time"
3047
- },
3048
- "data": {
3049
- "$ref": "#/components/schemas/WebhookMessageData"
3050
- },
3051
- "type": {
3052
- "type": "string",
3053
- "enum": ["automation-task.completed", "automation-task.limit-exceeded"]
3054
- }
3055
- }
3056
- },
3057
- "WebhookMessageData": {
3058
- "required": ["automation"],
3059
- "type": "object",
3060
- "properties": {
3061
- "automation": {
3062
- "$ref": "#/components/schemas/WebhookAutomationInfo"
3063
- },
3064
- "recipients": {
3065
- "type": "array",
3066
- "items": {
3067
- "$ref": "#/components/schemas/WebhookRecipient"
3068
- }
3069
- },
3070
- "details": {
3071
- "type": "object",
3072
- "additionalProperties": {
3073
- "type": "string"
3074
- }
3075
- },
3076
- "remainingActionCount": {
3077
- "type": "integer",
3078
- "format": "int32"
3079
- },
3080
- "tabularExports": {
3081
- "type": "array",
3082
- "items": {
3083
- "$ref": "#/components/schemas/ExportResult"
3084
- }
3085
- },
3086
- "visualExports": {
3087
- "type": "array",
3088
- "items": {
3089
- "$ref": "#/components/schemas/ExportResult"
3090
- }
3091
- },
3092
- "imageExports": {
3093
- "type": "array",
3094
- "items": {
3095
- "$ref": "#/components/schemas/ExportResult"
3096
- }
3097
- },
3098
- "rawExports": {
3099
- "type": "array",
3100
- "items": {
3101
- "$ref": "#/components/schemas/ExportResult"
3102
- }
3103
- },
3104
- "slidesExports": {
3105
- "type": "array",
3106
- "items": {
3107
- "$ref": "#/components/schemas/ExportResult"
3108
- }
3109
- },
3110
- "dashboardTabularExports": {
3111
- "type": "array",
3112
- "items": {
3113
- "$ref": "#/components/schemas/ExportResult"
3114
- }
3115
- },
3116
- "alert": {
3117
- "$ref": "#/components/schemas/AlertDescription"
3118
- },
3119
- "filters": {
3120
- "type": "array",
3121
- "items": {
3122
- "$ref": "#/components/schemas/NotificationFilter"
3123
- }
3124
- },
3125
- "notificationSource": {
3126
- "type": "string"
3127
- }
3128
- }
3129
- },
3130
- "WebhookRecipient": {
3131
- "required": ["email", "id"],
3132
- "type": "object",
3133
- "properties": {
3134
- "id": {
3135
- "type": "string"
3136
- },
3137
- "email": {
3138
- "type": "string"
3139
- }
3140
- }
3141
- }
3142
- }
3143
- }
3144
- }