@gooddata/api-client-tiger 10.27.0-alpha.8 → 10.27.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 (46) 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/esm/api-client-tiger.d.ts +4347 -1738
  6. package/esm/automation.d.ts +2 -3
  7. package/esm/automation.d.ts.map +1 -1
  8. package/esm/automation.js +2 -2
  9. package/esm/automation.js.map +1 -1
  10. package/esm/client.d.ts +2 -2
  11. package/esm/client.d.ts.map +1 -1
  12. package/esm/client.js +1 -1
  13. package/esm/client.js.map +1 -1
  14. package/esm/generated/afm-rest-api/api.d.ts +60 -8
  15. package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
  16. package/esm/generated/afm-rest-api/api.js +4 -4
  17. package/esm/generated/afm-rest-api/api.js.map +1 -1
  18. package/esm/generated/afm-rest-api/openapi-spec.json +51 -10
  19. package/esm/generated/automation-json-api/api.d.ts +1984 -705
  20. package/esm/generated/automation-json-api/api.d.ts.map +1 -1
  21. package/esm/generated/automation-json-api/api.js +275 -169
  22. package/esm/generated/automation-json-api/api.js.map +1 -1
  23. package/esm/generated/automation-json-api/openapi-spec.json +1046 -7
  24. package/esm/generated/export-json-api/api.d.ts +591 -4
  25. package/esm/generated/export-json-api/api.d.ts.map +1 -1
  26. package/esm/generated/export-json-api/api.js +522 -10
  27. package/esm/generated/export-json-api/api.js.map +1 -1
  28. package/esm/generated/export-json-api/openapi-spec.json +417 -1
  29. package/esm/generated/metadata-json-api/api.d.ts +1209 -1183
  30. package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
  31. package/esm/generated/metadata-json-api/api.js +76 -57
  32. package/esm/generated/metadata-json-api/api.js.map +1 -1
  33. package/esm/generated/metadata-json-api/openapi-spec.json +7953 -7935
  34. package/esm/generated/result-json-api/base.d.ts.map +1 -1
  35. package/esm/generated/result-json-api/base.js +1 -13
  36. package/esm/generated/result-json-api/base.js.map +1 -1
  37. package/esm/generated/scan-json-api/api.d.ts +2 -1
  38. package/esm/generated/scan-json-api/api.d.ts.map +1 -1
  39. package/esm/generated/scan-json-api/api.js +2 -1
  40. package/esm/generated/scan-json-api/api.js.map +1 -1
  41. package/esm/generated/scan-json-api/openapi-spec.json +3 -2
  42. package/esm/index.d.ts +5 -2
  43. package/esm/index.d.ts.map +1 -1
  44. package/esm/index.js +1 -0
  45. package/esm/index.js.map +1 -1
  46. package/package.json +4 -4
package/esm/generated/automation-json-api/openapi-spec.json CHANGED
@@ -314,6 +314,52 @@
314
314
  },
315
315
  "components": {
316
316
  "schemas": {
317
+ "AbsoluteDateFilter": {
318
+ "required": ["absoluteDateFilter"],
319
+ "type": "object",
320
+ "properties": {
321
+ "absoluteDateFilter": {
322
+ "required": ["from", "to", "dataset"],
323
+ "type": "object",
324
+ "properties": {
325
+ "from": {
326
+ "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$",
327
+ "type": "string",
328
+ "example": "2020-07-01 18:23"
329
+ },
330
+ "to": {
331
+ "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$",
332
+ "type": "string",
333
+ "example": "2020-07-16 23:59"
334
+ },
335
+ "localIdentifier": {
336
+ "type": "string"
337
+ },
338
+ "applyOnResult": {
339
+ "type": "boolean"
340
+ },
341
+ "dataset": {
342
+ "$ref": "#/components/schemas/AfmObjectIdentifierDataset"
343
+ }
344
+ }
345
+ }
346
+ },
347
+ "description": "A datetime filter specifying exact from and to values."
348
+ },
349
+ "AbstractMeasureValueFilter": {
350
+ "type": "object",
351
+ "oneOf": [
352
+ {
353
+ "$ref": "#/components/schemas/ComparisonMeasureValueFilter"
354
+ },
355
+ {
356
+ "$ref": "#/components/schemas/RangeMeasureValueFilter"
357
+ },
358
+ {
359
+ "$ref": "#/components/schemas/RankingFilter"
360
+ }
361
+ ]
362
+ },
317
363
  "AdHocAutomation": {
318
364
  "type": "object",
319
365
  "properties": {
@@ -347,6 +393,9 @@
347
393
  "metadata": {
348
394
  "$ref": "#/components/schemas/AutomationMetadata"
349
395
  },
396
+ "alert": {
397
+ "$ref": "#/components/schemas/AutomationAlert"
398
+ },
350
399
  "tabularExports": {
351
400
  "uniqueItems": true,
352
401
  "type": "array",
@@ -384,6 +433,334 @@
384
433
  }
385
434
  }
386
435
  },
436
+ "AfmIdentifier": {
437
+ "type": "object",
438
+ "description": "Reference to the attribute label to which the filter should be applied.",
439
+ "oneOf": [
440
+ {
441
+ "$ref": "#/components/schemas/AfmObjectIdentifier"
442
+ },
443
+ {
444
+ "$ref": "#/components/schemas/AfmLocalIdentifier"
445
+ }
446
+ ]
447
+ },
448
+ "AfmLocalIdentifier": {
449
+ "required": ["localIdentifier"],
450
+ "type": "object",
451
+ "properties": {
452
+ "localIdentifier": {
453
+ "pattern": "^[.a-zA-Z0-9_-]+$",
454
+ "type": "string",
455
+ "example": "sampleAutoGenerated0123_ID"
456
+ }
457
+ }
458
+ },
459
+ "AfmObjectIdentifier": {
460
+ "required": ["identifier"],
461
+ "type": "object",
462
+ "properties": {
463
+ "identifier": {
464
+ "required": ["type", "id"],
465
+ "type": "object",
466
+ "properties": {
467
+ "type": {
468
+ "type": "string",
469
+ "example": "fact",
470
+ "enum": [
471
+ "analyticalDashboard",
472
+ "attribute",
473
+ "dashboardPlugin",
474
+ "dataset",
475
+ "fact",
476
+ "label",
477
+ "metric",
478
+ "prompt",
479
+ "visualizationObject",
480
+ "filterContext"
481
+ ]
482
+ },
483
+ "id": {
484
+ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
485
+ "type": "string",
486
+ "example": "sample_item.price"
487
+ }
488
+ }
489
+ }
490
+ },
491
+ "description": "ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers."
492
+ },
493
+ "AfmObjectIdentifierAttribute": {
494
+ "required": ["identifier"],
495
+ "type": "object",
496
+ "properties": {
497
+ "identifier": {
498
+ "required": ["id", "type"],
499
+ "type": "object",
500
+ "properties": {
501
+ "id": {
502
+ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
503
+ "type": "string",
504
+ "example": "sample_item.price"
505
+ },
506
+ "type": {
507
+ "type": "string",
508
+ "enum": ["attribute"]
509
+ }
510
+ }
511
+ }
512
+ },
513
+ "description": "Reference to the date attribute to use."
514
+ },
515
+ "AfmObjectIdentifierCore": {
516
+ "required": ["identifier"],
517
+ "type": "object",
518
+ "properties": {
519
+ "identifier": {
520
+ "required": ["id", "type"],
521
+ "type": "object",
522
+ "properties": {
523
+ "id": {
524
+ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
525
+ "type": "string",
526
+ "example": "sample_item.price"
527
+ },
528
+ "type": {
529
+ "type": "string",
530
+ "enum": ["attribute", "label", "fact", "metric"]
531
+ }
532
+ }
533
+ }
534
+ },
535
+ "description": "Reference to the metric, fact or attribute object to use for the metric."
536
+ },
537
+ "AfmObjectIdentifierDataset": {
538
+ "required": ["identifier"],
539
+ "type": "object",
540
+ "properties": {
541
+ "identifier": {
542
+ "required": ["id", "type"],
543
+ "type": "object",
544
+ "properties": {
545
+ "id": {
546
+ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
547
+ "type": "string",
548
+ "example": "sample_item.price"
549
+ },
550
+ "type": {
551
+ "type": "string",
552
+ "enum": ["dataset"]
553
+ }
554
+ }
555
+ }
556
+ },
557
+ "description": "Reference to the date dataset to which the filter should be applied."
558
+ },
559
+ "AfmObjectIdentifierLabel": {
560
+ "required": ["identifier"],
561
+ "type": "object",
562
+ "properties": {
563
+ "identifier": {
564
+ "required": ["type", "id"],
565
+ "type": "object",
566
+ "properties": {
567
+ "type": {
568
+ "type": "string",
569
+ "enum": ["label"]
570
+ },
571
+ "id": {
572
+ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
573
+ "type": "string",
574
+ "example": "sample_item.price"
575
+ }
576
+ }
577
+ }
578
+ }
579
+ },
580
+ "AlertAfm": {
581
+ "required": ["filters", "measures"],
582
+ "type": "object",
583
+ "properties": {
584
+ "attributes": {
585
+ "maximum": 1,
586
+ "type": "array",
587
+ "description": "Attributes to be used in the computation.",
588
+ "items": {
589
+ "$ref": "#/components/schemas/AttributeItem"
590
+ }
591
+ },
592
+ "filters": {
593
+ "type": "array",
594
+ "description": "Various filter types to filter execution result.",
595
+ "items": {
596
+ "$ref": "#/components/schemas/FilterDefinition"
597
+ }
598
+ },
599
+ "measures": {
600
+ "maximum": 2,
601
+ "minimum": 1,
602
+ "type": "array",
603
+ "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.",
604
+ "items": {
605
+ "$ref": "#/components/schemas/MeasureItem"
606
+ }
607
+ },
608
+ "auxMeasures": {
609
+ "type": "array",
610
+ "description": "Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.",
611
+ "items": {
612
+ "$ref": "#/components/schemas/MeasureItem"
613
+ }
614
+ }
615
+ }
616
+ },
617
+ "AlertCondition": {
618
+ "type": "object",
619
+ "description": "Alert trigger condition.",
620
+ "oneOf": [
621
+ {
622
+ "$ref": "#/components/schemas/ComparisonWrapper"
623
+ },
624
+ {
625
+ "$ref": "#/components/schemas/RangeWrapper"
626
+ },
627
+ {
628
+ "$ref": "#/components/schemas/RelativeWrapper"
629
+ }
630
+ ]
631
+ },
632
+ "AlertConditionOperand": {
633
+ "type": "object",
634
+ "description": "Operand of the alert condition.",
635
+ "oneOf": [
636
+ {
637
+ "$ref": "#/components/schemas/LocalIdentifier"
638
+ },
639
+ {
640
+ "$ref": "#/components/schemas/Value"
641
+ }
642
+ ]
643
+ },
644
+ "ArithmeticMeasure": {
645
+ "required": ["left", "operator", "right"],
646
+ "type": "object",
647
+ "properties": {
648
+ "operator": {
649
+ "type": "string",
650
+ "description": "Arithmetic operator.\nDIFFERENCE - m₁−m₂ - the difference between two metrics.\nCHANGE - (m₁−m₂)÷m₂ - the relative difference between two metrics.\n",
651
+ "enum": ["DIFFERENCE", "CHANGE"]
652
+ },
653
+ "left": {
654
+ "$ref": "#/components/schemas/LocalIdentifier"
655
+ },
656
+ "right": {
657
+ "$ref": "#/components/schemas/LocalIdentifier"
658
+ }
659
+ }
660
+ },
661
+ "ArithmeticMeasureDefinition": {
662
+ "required": ["arithmeticMeasure"],
663
+ "type": "object",
664
+ "properties": {
665
+ "arithmeticMeasure": {
666
+ "required": ["measureIdentifiers", "operator"],
667
+ "type": "object",
668
+ "properties": {
669
+ "measureIdentifiers": {
670
+ "type": "array",
671
+ "description": "List of metrics to apply arithmetic operation by chosen operator.",
672
+ "items": {
673
+ "$ref": "#/components/schemas/AfmLocalIdentifier"
674
+ }
675
+ },
676
+ "operator": {
677
+ "type": "string",
678
+ "description": "Arithmetic operator describing operation between metrics.",
679
+ "example": "SUM",
680
+ "enum": ["SUM", "DIFFERENCE", "MULTIPLICATION", "RATIO", "CHANGE"]
681
+ }
682
+ }
683
+ }
684
+ },
685
+ "description": "Metric representing arithmetics between other metrics."
686
+ },
687
+ "AttributeFilter": {
688
+ "type": "object",
689
+ "description": "Abstract filter definition type attributes",
690
+ "oneOf": [
691
+ {
692
+ "$ref": "#/components/schemas/NegativeAttributeFilter"
693
+ },
694
+ {
695
+ "$ref": "#/components/schemas/PositiveAttributeFilter"
696
+ }
697
+ ]
698
+ },
699
+ "AttributeFilterElements": {
700
+ "required": ["values"],
701
+ "type": "object",
702
+ "properties": {
703
+ "values": {
704
+ "uniqueItems": true,
705
+ "type": "array",
706
+ "description": "Set of label values.",
707
+ "example": ["value1", "value2"],
708
+ "items": {
709
+ "type": "string",
710
+ "nullable": true
711
+ }
712
+ }
713
+ },
714
+ "description": "Filter on specific set of label values."
715
+ },
716
+ "AttributeItem": {
717
+ "required": ["label", "localIdentifier"],
718
+ "type": "object",
719
+ "properties": {
720
+ "localIdentifier": {
721
+ "pattern": "^[.a-zA-Z0-9_-]+$",
722
+ "type": "string",
723
+ "description": "Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.",
724
+ "example": "attribute_1"
725
+ },
726
+ "label": {
727
+ "$ref": "#/components/schemas/AfmObjectIdentifierLabel"
728
+ },
729
+ "showAllValues": {
730
+ "type": "boolean",
731
+ "description": "Indicates whether to show all values of given attribute even if the data bound to those values is not available.",
732
+ "default": false
733
+ }
734
+ }
735
+ },
736
+ "AutomationAlert": {
737
+ "required": ["condition", "execution"],
738
+ "type": "object",
739
+ "properties": {
740
+ "execution": {
741
+ "$ref": "#/components/schemas/AlertAfm"
742
+ },
743
+ "condition": {
744
+ "oneOf": [
745
+ {
746
+ "$ref": "#/components/schemas/ComparisonWrapper"
747
+ },
748
+ {
749
+ "$ref": "#/components/schemas/RangeWrapper"
750
+ },
751
+ {
752
+ "$ref": "#/components/schemas/RelativeWrapper"
753
+ }
754
+ ]
755
+ },
756
+ "trigger": {
757
+ "type": "string",
758
+ "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",
759
+ "default": "ALWAYS",
760
+ "enum": ["ALWAYS", "ONCE"]
761
+ }
762
+ }
763
+ },
387
764
  "AutomationExternalRecipient": {
388
765
  "required": ["email"],
389
766
  "type": "object",
@@ -396,7 +773,7 @@
396
773
  }
397
774
  },
398
775
  "AutomationMetadata": {
399
- "maxLength": 15000,
776
+ "maxLength": 250000,
400
777
  "type": "object",
401
778
  "properties": {
402
779
  "widget": {
@@ -430,6 +807,88 @@
430
807
  }
431
808
  }
432
809
  },
810
+ "Comparison": {
811
+ "required": ["left", "operator", "right"],
812
+ "type": "object",
813
+ "properties": {
814
+ "operator": {
815
+ "type": "string",
816
+ "enum": [
817
+ "GREATER_THAN",
818
+ "GREATER_THAN_OR_EQUAL_TO",
819
+ "LESS_THAN",
820
+ "LESS_THAN_OR_EQUAL_TO",
821
+ "EQUAL_TO",
822
+ "NOT_EQUAL_TO"
823
+ ]
824
+ },
825
+ "left": {
826
+ "$ref": "#/components/schemas/LocalIdentifier"
827
+ },
828
+ "right": {
829
+ "$ref": "#/components/schemas/AlertConditionOperand"
830
+ }
831
+ }
832
+ },
833
+ "ComparisonMeasureValueFilter": {
834
+ "required": ["comparisonMeasureValueFilter"],
835
+ "type": "object",
836
+ "properties": {
837
+ "comparisonMeasureValueFilter": {
838
+ "required": ["operator", "value", "measure"],
839
+ "type": "object",
840
+ "properties": {
841
+ "dimensionality": {
842
+ "type": "array",
843
+ "description": "References to the attributes to be used when filtering.",
844
+ "items": {
845
+ "$ref": "#/components/schemas/AfmIdentifier"
846
+ }
847
+ },
848
+ "treatNullValuesAs": {
849
+ "type": "number",
850
+ "description": "A value that will be substituted for null values in the metric for the comparisons.",
851
+ "example": 0
852
+ },
853
+ "operator": {
854
+ "type": "string",
855
+ "example": "GREATER_THAN",
856
+ "enum": [
857
+ "GREATER_THAN",
858
+ "GREATER_THAN_OR_EQUAL_TO",
859
+ "LESS_THAN",
860
+ "LESS_THAN_OR_EQUAL_TO",
861
+ "EQUAL_TO",
862
+ "NOT_EQUAL_TO"
863
+ ]
864
+ },
865
+ "value": {
866
+ "type": "number",
867
+ "example": 1327
868
+ },
869
+ "localIdentifier": {
870
+ "type": "string"
871
+ },
872
+ "applyOnResult": {
873
+ "type": "boolean"
874
+ },
875
+ "measure": {
876
+ "$ref": "#/components/schemas/AfmIdentifier"
877
+ }
878
+ }
879
+ }
880
+ },
881
+ "description": "Filter the result by comparing specified metric to given constant value, using given comparison operator."
882
+ },
883
+ "ComparisonWrapper": {
884
+ "required": ["comparison"],
885
+ "type": "object",
886
+ "properties": {
887
+ "comparison": {
888
+ "$ref": "#/components/schemas/Comparison"
889
+ }
890
+ }
891
+ },
433
892
  "CustomLabel": {
434
893
  "required": ["title"],
435
894
  "type": "object",
@@ -476,6 +935,18 @@
476
935
  },
477
936
  "description": "Custom cell value overrides (IDs will be replaced with specified values)."
478
937
  },
938
+ "DateFilter": {
939
+ "type": "object",
940
+ "description": "Abstract filter definition type for dates.",
941
+ "oneOf": [
942
+ {
943
+ "$ref": "#/components/schemas/AbsoluteDateFilter"
944
+ },
945
+ {
946
+ "$ref": "#/components/schemas/RelativeDateFilter"
947
+ }
948
+ ]
949
+ },
479
950
  "DeclarativeAnalyticalDashboardIdentifier": {
480
951
  "required": ["id", "type"],
481
952
  "type": "object",
@@ -533,13 +1004,211 @@
533
1004
  },
534
1005
  "description": "A user identifier."
535
1006
  },
536
- "JsonNode": {
537
- "maxLength": 15000,
1007
+ "FilterDefinition": {
538
1008
  "type": "object",
539
- "description": "Metadata definition in free-form JSON format.",
540
- "nullable": true,
541
- "example": {}
542
- },
1009
+ "description": "Abstract filter definition type",
1010
+ "oneOf": [
1011
+ {
1012
+ "$ref": "#/components/schemas/InlineFilterDefinition"
1013
+ },
1014
+ {
1015
+ "$ref": "#/components/schemas/RankingFilter"
1016
+ },
1017
+ {
1018
+ "$ref": "#/components/schemas/ComparisonMeasureValueFilter"
1019
+ },
1020
+ {
1021
+ "$ref": "#/components/schemas/RangeMeasureValueFilter"
1022
+ },
1023
+ {
1024
+ "$ref": "#/components/schemas/AbsoluteDateFilter"
1025
+ },
1026
+ {
1027
+ "$ref": "#/components/schemas/RelativeDateFilter"
1028
+ },
1029
+ {
1030
+ "$ref": "#/components/schemas/NegativeAttributeFilter"
1031
+ },
1032
+ {
1033
+ "$ref": "#/components/schemas/PositiveAttributeFilter"
1034
+ }
1035
+ ]
1036
+ },
1037
+ "FilterDefinitionForSimpleMeasure": {
1038
+ "type": "object",
1039
+ "description": "Abstract filter definition type for simple metric.",
1040
+ "oneOf": [
1041
+ {
1042
+ "$ref": "#/components/schemas/DateFilter"
1043
+ },
1044
+ {
1045
+ "$ref": "#/components/schemas/AttributeFilter"
1046
+ }
1047
+ ]
1048
+ },
1049
+ "InlineFilterDefinition": {
1050
+ "required": ["inline"],
1051
+ "type": "object",
1052
+ "properties": {
1053
+ "inline": {
1054
+ "required": ["filter"],
1055
+ "type": "object",
1056
+ "properties": {
1057
+ "filter": {
1058
+ "type": "string",
1059
+ "description": "MAQL query representing the filter."
1060
+ },
1061
+ "localIdentifier": {
1062
+ "type": "string"
1063
+ },
1064
+ "applyOnResult": {
1065
+ "type": "boolean"
1066
+ }
1067
+ }
1068
+ }
1069
+ },
1070
+ "description": "Filter in form of direct MAQL query."
1071
+ },
1072
+ "InlineMeasureDefinition": {
1073
+ "required": ["inline"],
1074
+ "type": "object",
1075
+ "properties": {
1076
+ "inline": {
1077
+ "required": ["maql"],
1078
+ "type": "object",
1079
+ "properties": {
1080
+ "maql": {
1081
+ "type": "string",
1082
+ "description": "MAQL query defining the metric."
1083
+ }
1084
+ }
1085
+ }
1086
+ },
1087
+ "description": "Metric defined by the raw MAQL query."
1088
+ },
1089
+ "JsonNode": {
1090
+ "maxLength": 15000,
1091
+ "type": "object",
1092
+ "description": "Metadata definition in free-form JSON format.",
1093
+ "nullable": true,
1094
+ "example": {}
1095
+ },
1096
+ "LocalIdentifier": {
1097
+ "required": ["localIdentifier"],
1098
+ "type": "object",
1099
+ "properties": {
1100
+ "localIdentifier": {
1101
+ "type": "string",
1102
+ "description": "Local identifier of the metric to be compared.",
1103
+ "example": "m1"
1104
+ },
1105
+ "format": {
1106
+ "maxLength": 2048,
1107
+ "type": "string",
1108
+ "description": "Metric format.",
1109
+ "nullable": true,
1110
+ "example": "#,##0",
1111
+ "default": "#,##0.00"
1112
+ },
1113
+ "title": {
1114
+ "maxLength": 255,
1115
+ "type": "string",
1116
+ "description": "Metric title.",
1117
+ "nullable": true,
1118
+ "example": "Revenue"
1119
+ }
1120
+ }
1121
+ },
1122
+ "MeasureDefinition": {
1123
+ "type": "object",
1124
+ "description": "Abstract metric definition type",
1125
+ "oneOf": [
1126
+ {
1127
+ "$ref": "#/components/schemas/InlineMeasureDefinition"
1128
+ },
1129
+ {
1130
+ "$ref": "#/components/schemas/ArithmeticMeasureDefinition"
1131
+ },
1132
+ {
1133
+ "$ref": "#/components/schemas/SimpleMeasureDefinition"
1134
+ },
1135
+ {
1136
+ "$ref": "#/components/schemas/PopMeasureDefinition"
1137
+ }
1138
+ ]
1139
+ },
1140
+ "MeasureItem": {
1141
+ "required": ["definition", "localIdentifier"],
1142
+ "type": "object",
1143
+ "properties": {
1144
+ "localIdentifier": {
1145
+ "pattern": "^[.a-zA-Z0-9_-]+$",
1146
+ "type": "string",
1147
+ "description": "Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.",
1148
+ "example": "metric_1"
1149
+ },
1150
+ "definition": {
1151
+ "oneOf": [
1152
+ {
1153
+ "$ref": "#/components/schemas/ArithmeticMeasureDefinition"
1154
+ },
1155
+ {
1156
+ "$ref": "#/components/schemas/InlineMeasureDefinition"
1157
+ },
1158
+ {
1159
+ "$ref": "#/components/schemas/PopDatasetMeasureDefinition"
1160
+ },
1161
+ {
1162
+ "$ref": "#/components/schemas/PopDateMeasureDefinition"
1163
+ },
1164
+ {
1165
+ "$ref": "#/components/schemas/PopMeasureDefinition"
1166
+ },
1167
+ {
1168
+ "$ref": "#/components/schemas/SimpleMeasureDefinition"
1169
+ }
1170
+ ]
1171
+ }
1172
+ },
1173
+ "description": "Metric is a quantity that is calculated from the data."
1174
+ },
1175
+ "MeasureValueFilter": {
1176
+ "type": "object",
1177
+ "description": "Abstract filter definition type filtering by the value of the metric.",
1178
+ "oneOf": [
1179
+ {
1180
+ "$ref": "#/components/schemas/ComparisonMeasureValueFilter"
1181
+ },
1182
+ {
1183
+ "$ref": "#/components/schemas/RangeMeasureValueFilter"
1184
+ }
1185
+ ]
1186
+ },
1187
+ "NegativeAttributeFilter": {
1188
+ "required": ["negativeAttributeFilter"],
1189
+ "type": "object",
1190
+ "properties": {
1191
+ "negativeAttributeFilter": {
1192
+ "required": ["notIn", "label"],
1193
+ "type": "object",
1194
+ "properties": {
1195
+ "notIn": {
1196
+ "$ref": "#/components/schemas/AttributeFilterElements"
1197
+ },
1198
+ "localIdentifier": {
1199
+ "type": "string"
1200
+ },
1201
+ "applyOnResult": {
1202
+ "type": "boolean"
1203
+ },
1204
+ "label": {
1205
+ "$ref": "#/components/schemas/AfmIdentifier"
1206
+ }
1207
+ }
1208
+ }
1209
+ },
1210
+ "description": "Filter able to limit element values by label and related selected negated elements."
1211
+ },
543
1212
  "PdfTableStyle": {
544
1213
  "required": ["selector"],
545
1214
  "type": "object",
@@ -584,6 +1253,321 @@
584
1253
  },
585
1254
  "description": "CSS property."
586
1255
  },
1256
+ "PopDataset": {
1257
+ "required": ["dataset", "periodsAgo"],
1258
+ "type": "object",
1259
+ "properties": {
1260
+ "dataset": {
1261
+ "$ref": "#/components/schemas/AfmObjectIdentifierDataset"
1262
+ },
1263
+ "periodsAgo": {
1264
+ "type": "integer",
1265
+ "description": "Number of periods ago to calculate the previous period for.",
1266
+ "format": "int32",
1267
+ "example": 1
1268
+ }
1269
+ },
1270
+ "description": "Combination of the date data set to use and how many periods ago to calculate the previous period for."
1271
+ },
1272
+ "PopDatasetMeasureDefinition": {
1273
+ "required": ["previousPeriodMeasure"],
1274
+ "type": "object",
1275
+ "properties": {
1276
+ "previousPeriodMeasure": {
1277
+ "required": ["dateDatasets", "measureIdentifier"],
1278
+ "type": "object",
1279
+ "properties": {
1280
+ "measureIdentifier": {
1281
+ "$ref": "#/components/schemas/AfmLocalIdentifier"
1282
+ },
1283
+ "dateDatasets": {
1284
+ "type": "array",
1285
+ "description": "Specification of which date data sets to use for determining the period to calculate the previous period for.",
1286
+ "items": {
1287
+ "$ref": "#/components/schemas/PopDataset"
1288
+ }
1289
+ }
1290
+ }
1291
+ }
1292
+ },
1293
+ "description": "Previous period type of metric."
1294
+ },
1295
+ "PopDate": {
1296
+ "required": ["attribute", "periodsAgo"],
1297
+ "type": "object",
1298
+ "properties": {
1299
+ "attribute": {
1300
+ "$ref": "#/components/schemas/AfmObjectIdentifierAttribute"
1301
+ },
1302
+ "periodsAgo": {
1303
+ "type": "integer",
1304
+ "description": "Number of periods ago to calculate the previous period for.",
1305
+ "format": "int32",
1306
+ "example": 1
1307
+ }
1308
+ },
1309
+ "description": "Combination of the date attribute to use and how many periods ago to calculate the PoP for."
1310
+ },
1311
+ "PopDateMeasureDefinition": {
1312
+ "required": ["overPeriodMeasure"],
1313
+ "type": "object",
1314
+ "properties": {
1315
+ "overPeriodMeasure": {
1316
+ "required": ["dateAttributes", "measureIdentifier"],
1317
+ "type": "object",
1318
+ "properties": {
1319
+ "measureIdentifier": {
1320
+ "$ref": "#/components/schemas/AfmLocalIdentifier"
1321
+ },
1322
+ "dateAttributes": {
1323
+ "type": "array",
1324
+ "description": "Attributes to use for determining the period to calculate the PoP for.",
1325
+ "items": {
1326
+ "$ref": "#/components/schemas/PopDate"
1327
+ }
1328
+ }
1329
+ }
1330
+ }
1331
+ },
1332
+ "description": "Period over period type of metric."
1333
+ },
1334
+ "PopMeasureDefinition": {
1335
+ "type": "object",
1336
+ "oneOf": [
1337
+ {
1338
+ "$ref": "#/components/schemas/PopDatasetMeasureDefinition"
1339
+ },
1340
+ {
1341
+ "$ref": "#/components/schemas/PopDateMeasureDefinition"
1342
+ }
1343
+ ]
1344
+ },
1345
+ "PositiveAttributeFilter": {
1346
+ "required": ["positiveAttributeFilter"],
1347
+ "type": "object",
1348
+ "properties": {
1349
+ "positiveAttributeFilter": {
1350
+ "required": ["in", "label"],
1351
+ "type": "object",
1352
+ "properties": {
1353
+ "in": {
1354
+ "$ref": "#/components/schemas/AttributeFilterElements"
1355
+ },
1356
+ "localIdentifier": {
1357
+ "type": "string"
1358
+ },
1359
+ "applyOnResult": {
1360
+ "type": "boolean"
1361
+ },
1362
+ "label": {
1363
+ "$ref": "#/components/schemas/AfmIdentifier"
1364
+ }
1365
+ }
1366
+ }
1367
+ },
1368
+ "description": "Filter able to limit element values by label and related selected elements."
1369
+ },
1370
+ "Range": {
1371
+ "required": ["from", "measure", "operator", "to"],
1372
+ "type": "object",
1373
+ "properties": {
1374
+ "operator": {
1375
+ "type": "string",
1376
+ "enum": ["BETWEEN", "NOT_BETWEEN"]
1377
+ },
1378
+ "measure": {
1379
+ "$ref": "#/components/schemas/LocalIdentifier"
1380
+ },
1381
+ "from": {
1382
+ "$ref": "#/components/schemas/Value"
1383
+ },
1384
+ "to": {
1385
+ "$ref": "#/components/schemas/Value"
1386
+ }
1387
+ }
1388
+ },
1389
+ "RangeMeasureValueFilter": {
1390
+ "required": ["rangeMeasureValueFilter"],
1391
+ "type": "object",
1392
+ "properties": {
1393
+ "rangeMeasureValueFilter": {
1394
+ "required": ["from", "operator", "to", "measure"],
1395
+ "type": "object",
1396
+ "properties": {
1397
+ "dimensionality": {
1398
+ "type": "array",
1399
+ "description": "References to the attributes to be used when filtering.",
1400
+ "items": {
1401
+ "$ref": "#/components/schemas/AfmIdentifier"
1402
+ }
1403
+ },
1404
+ "treatNullValuesAs": {
1405
+ "type": "number",
1406
+ "description": "A value that will be substituted for null values in the metric for the comparisons.",
1407
+ "example": 0
1408
+ },
1409
+ "operator": {
1410
+ "type": "string",
1411
+ "example": "BETWEEN",
1412
+ "enum": ["BETWEEN", "NOT_BETWEEN"]
1413
+ },
1414
+ "from": {
1415
+ "type": "number",
1416
+ "example": 100
1417
+ },
1418
+ "to": {
1419
+ "type": "number",
1420
+ "example": 999
1421
+ },
1422
+ "localIdentifier": {
1423
+ "type": "string"
1424
+ },
1425
+ "applyOnResult": {
1426
+ "type": "boolean"
1427
+ },
1428
+ "measure": {
1429
+ "$ref": "#/components/schemas/AfmIdentifier"
1430
+ }
1431
+ }
1432
+ }
1433
+ },
1434
+ "description": "Filter the result by comparing specified metric to given range of values."
1435
+ },
1436
+ "RangeWrapper": {
1437
+ "required": ["range"],
1438
+ "type": "object",
1439
+ "properties": {
1440
+ "range": {
1441
+ "$ref": "#/components/schemas/Range"
1442
+ }
1443
+ }
1444
+ },
1445
+ "RankingFilter": {
1446
+ "required": ["rankingFilter"],
1447
+ "type": "object",
1448
+ "properties": {
1449
+ "rankingFilter": {
1450
+ "required": ["measures", "operator", "value"],
1451
+ "type": "object",
1452
+ "properties": {
1453
+ "dimensionality": {
1454
+ "type": "array",
1455
+ "description": "References to the attributes to be used when filtering.",
1456
+ "items": {
1457
+ "$ref": "#/components/schemas/AfmIdentifier"
1458
+ }
1459
+ },
1460
+ "measures": {
1461
+ "type": "array",
1462
+ "description": "References to the metrics to be used when filtering.",
1463
+ "items": {
1464
+ "$ref": "#/components/schemas/AfmIdentifier"
1465
+ }
1466
+ },
1467
+ "operator": {
1468
+ "type": "string",
1469
+ "description": "The type of ranking to use, TOP or BOTTOM.",
1470
+ "enum": ["TOP", "BOTTOM"]
1471
+ },
1472
+ "value": {
1473
+ "type": "integer",
1474
+ "description": "Number of top/bottom values to filter.",
1475
+ "format": "int32",
1476
+ "example": 5
1477
+ },
1478
+ "localIdentifier": {
1479
+ "type": "string"
1480
+ },
1481
+ "applyOnResult": {
1482
+ "type": "boolean"
1483
+ }
1484
+ }
1485
+ }
1486
+ },
1487
+ "description": "Filter the result on top/bottom N values according to given metric(s)."
1488
+ },
1489
+ "Relative": {
1490
+ "required": ["measure", "operator", "threshold"],
1491
+ "type": "object",
1492
+ "properties": {
1493
+ "operator": {
1494
+ "type": "string",
1495
+ "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",
1496
+ "enum": ["INCREASES_BY", "DECREASES_BY", "CHANGES_BY"]
1497
+ },
1498
+ "measure": {
1499
+ "$ref": "#/components/schemas/ArithmeticMeasure"
1500
+ },
1501
+ "threshold": {
1502
+ "$ref": "#/components/schemas/Value"
1503
+ }
1504
+ }
1505
+ },
1506
+ "RelativeDateFilter": {
1507
+ "required": ["relativeDateFilter"],
1508
+ "type": "object",
1509
+ "properties": {
1510
+ "relativeDateFilter": {
1511
+ "required": ["from", "granularity", "to", "dataset"],
1512
+ "type": "object",
1513
+ "properties": {
1514
+ "granularity": {
1515
+ "type": "string",
1516
+ "description": "Date granularity specifying particular date attribute in given dimension.",
1517
+ "example": "DAY",
1518
+ "enum": [
1519
+ "MINUTE",
1520
+ "HOUR",
1521
+ "DAY",
1522
+ "WEEK",
1523
+ "MONTH",
1524
+ "QUARTER",
1525
+ "YEAR",
1526
+ "MINUTE_OF_HOUR",
1527
+ "HOUR_OF_DAY",
1528
+ "DAY_OF_WEEK",
1529
+ "DAY_OF_MONTH",
1530
+ "DAY_OF_YEAR",
1531
+ "WEEK_OF_YEAR",
1532
+ "MONTH_OF_YEAR",
1533
+ "QUARTER_OF_YEAR"
1534
+ ]
1535
+ },
1536
+ "from": {
1537
+ "type": "integer",
1538
+ "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').",
1539
+ "format": "int32",
1540
+ "example": -6
1541
+ },
1542
+ "to": {
1543
+ "type": "integer",
1544
+ "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, ...).",
1545
+ "format": "int32",
1546
+ "example": 0
1547
+ },
1548
+ "localIdentifier": {
1549
+ "type": "string"
1550
+ },
1551
+ "applyOnResult": {
1552
+ "type": "boolean"
1553
+ },
1554
+ "dataset": {
1555
+ "$ref": "#/components/schemas/AfmObjectIdentifierDataset"
1556
+ }
1557
+ }
1558
+ }
1559
+ },
1560
+ "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."
1561
+ },
1562
+ "RelativeWrapper": {
1563
+ "required": ["relative"],
1564
+ "type": "object",
1565
+ "properties": {
1566
+ "relative": {
1567
+ "$ref": "#/components/schemas/Relative"
1568
+ }
1569
+ }
1570
+ },
587
1571
  "Settings": {
588
1572
  "type": "object",
589
1573
  "properties": {
@@ -633,6 +1617,50 @@
633
1617
  },
634
1618
  "description": "Additional settings."
635
1619
  },
1620
+ "SimpleMeasureDefinition": {
1621
+ "required": ["measure"],
1622
+ "type": "object",
1623
+ "properties": {
1624
+ "measure": {
1625
+ "required": ["item"],
1626
+ "type": "object",
1627
+ "properties": {
1628
+ "item": {
1629
+ "$ref": "#/components/schemas/AfmObjectIdentifierCore"
1630
+ },
1631
+ "aggregation": {
1632
+ "type": "string",
1633
+ "description": "Definition of aggregation type of the metric.",
1634
+ "example": "SUM",
1635
+ "enum": [
1636
+ "SUM",
1637
+ "COUNT",
1638
+ "AVG",
1639
+ "MIN",
1640
+ "MAX",
1641
+ "MEDIAN",
1642
+ "RUNSUM",
1643
+ "APPROXIMATE_COUNT"
1644
+ ]
1645
+ },
1646
+ "computeRatio": {
1647
+ "type": "boolean",
1648
+ "description": "If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).",
1649
+ "example": true,
1650
+ "default": false
1651
+ },
1652
+ "filters": {
1653
+ "type": "array",
1654
+ "description": "Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.",
1655
+ "items": {
1656
+ "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure"
1657
+ }
1658
+ }
1659
+ }
1660
+ }
1661
+ },
1662
+ "description": "Metric defined by referencing a MAQL metric or an LDM fact object with aggregation."
1663
+ },
636
1664
  "TabularExportRequest": {
637
1665
  "required": ["fileName", "format"],
638
1666
  "type": "object",
@@ -692,6 +1720,17 @@
692
1720
  }
693
1721
  }
694
1722
  },
1723
+ "Value": {
1724
+ "required": ["value"],
1725
+ "type": "object",
1726
+ "properties": {
1727
+ "value": {
1728
+ "type": "number",
1729
+ "description": "Value of the alert threshold to compare the metric to.",
1730
+ "example": 1000
1731
+ }
1732
+ }
1733
+ },
695
1734
  "VisibleFilter": {
696
1735
  "type": "object",
697
1736
  "properties": {