@gooddata/api-client-tiger 10.21.0-alpha.3 → 10.21.0-alpha.30

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 (38) 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 +2700 -1516
  6. package/esm/client.d.ts +3 -3
  7. package/esm/client.d.ts.map +1 -1
  8. package/esm/client.js +3 -3
  9. package/esm/client.js.map +1 -1
  10. package/esm/export.d.ts +3 -3
  11. package/esm/export.d.ts.map +1 -1
  12. package/esm/export.js +2 -2
  13. package/esm/export.js.map +1 -1
  14. package/esm/generated/afm-rest-api/api.js +1 -1
  15. package/esm/generated/afm-rest-api/api.js.map +1 -1
  16. package/esm/generated/afm-rest-api/openapi-spec.json +1 -1
  17. package/esm/generated/auth-json-api/api.js +1 -1
  18. package/esm/generated/automation-json-api/api.js +1 -1
  19. package/esm/generated/automation-json-api/api.js.map +1 -1
  20. package/esm/generated/automation-json-api/base.js +1 -1
  21. package/esm/generated/automation-json-api/common.js +1 -1
  22. package/esm/generated/automation-json-api/configuration.js +1 -1
  23. package/esm/generated/automation-json-api/index.js +1 -1
  24. package/esm/generated/export-json-api/api.d.ts +1495 -30
  25. package/esm/generated/export-json-api/api.d.ts.map +1 -1
  26. package/esm/generated/export-json-api/api.js +569 -1
  27. package/esm/generated/export-json-api/api.js.map +1 -1
  28. package/esm/generated/export-json-api/openapi-spec.json +1001 -1
  29. package/esm/generated/metadata-json-api/api.d.ts +1328 -1349
  30. package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
  31. package/esm/generated/metadata-json-api/api.js +41 -38
  32. package/esm/generated/metadata-json-api/api.js.map +1 -1
  33. package/esm/generated/metadata-json-api/openapi-spec.json +5704 -5717
  34. package/esm/generated/scan-json-api/api.js +1 -1
  35. package/esm/index.d.ts +1 -1
  36. package/esm/index.d.ts.map +1 -1
  37. package/esm/index.js.map +1 -1
  38. package/package.json +3 -3
package/esm/generated/export-json-api/openapi-spec.json CHANGED
@@ -105,6 +105,92 @@
105
105
  }
106
106
  }
107
107
  },
108
+ "/api/v1/actions/workspaces/{workspaceId}/export/raw": {
109
+ "post": {
110
+ "tags": ["Raw export", "actions"],
111
+ "summary": "(EXPERIMENTAL) Create raw export request",
112
+ "description": "Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.",
113
+ "operationId": "createRawExport",
114
+ "parameters": [
115
+ {
116
+ "name": "workspaceId",
117
+ "in": "path",
118
+ "required": true,
119
+ "schema": {
120
+ "type": "string"
121
+ }
122
+ }
123
+ ],
124
+ "requestBody": {
125
+ "content": {
126
+ "application/json": {
127
+ "schema": {
128
+ "$ref": "#/components/schemas/RawExportRequest"
129
+ }
130
+ }
131
+ },
132
+ "required": true
133
+ },
134
+ "responses": {
135
+ "201": {
136
+ "description": "Raw export request created successfully.",
137
+ "content": {
138
+ "application/json": {
139
+ "schema": {
140
+ "$ref": "#/components/schemas/ExportResponse"
141
+ }
142
+ }
143
+ }
144
+ }
145
+ },
146
+ "x-gdc-security-info": {
147
+ "permissions": ["EXPORT_TABULAR"],
148
+ "description": "Permissions required to execute raw export."
149
+ }
150
+ }
151
+ },
152
+ "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular": {
153
+ "post": {
154
+ "tags": ["Tabular export", "actions"],
155
+ "summary": "(EXPERIMENTAL) Create dashboard tabular export request",
156
+ "description": "Note: This API is an experimental and is going to change. Please, use it accordingly.An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.",
157
+ "operationId": "createDashboardExportRequest",
158
+ "parameters": [
159
+ {
160
+ "name": "workspaceId",
161
+ "in": "path",
162
+ "required": true,
163
+ "schema": {
164
+ "type": "string"
165
+ }
166
+ },
167
+ {
168
+ "name": "dashboardId",
169
+ "in": "path",
170
+ "required": true,
171
+ "schema": {
172
+ "type": "string"
173
+ }
174
+ }
175
+ ],
176
+ "responses": {
177
+ "201": {
178
+ "description": "Tabular export request created successfully.",
179
+ "content": {
180
+ "application/json": {
181
+ "schema": {
182
+ "$ref": "#/components/schemas/ExportResponse"
183
+ }
184
+ }
185
+ }
186
+ }
187
+ },
188
+ "x-gdc-security-info": {
189
+ "permissions": ["EXPORT_TABULAR"],
190
+ "description": "Permissions required to execute tabular export."
191
+ }
192
+ }
193
+ },
108
194
  "/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}/metadata": {
109
195
  "get": {
110
196
  "tags": ["actions", "Visual export"],
@@ -281,6 +367,79 @@
281
367
  "description": "Minimal permission required to use this endpoint."
282
368
  }
283
369
  }
370
+ },
371
+ "/api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId}": {
372
+ "get": {
373
+ "tags": ["Raw export", "actions"],
374
+ "summary": "(EXPERIMENTAL) Retrieve exported files",
375
+ "description": "Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.",
376
+ "operationId": "getRawExport",
377
+ "parameters": [
378
+ {
379
+ "name": "workspaceId",
380
+ "in": "path",
381
+ "required": true,
382
+ "schema": {
383
+ "type": "string"
384
+ }
385
+ },
386
+ {
387
+ "name": "exportId",
388
+ "in": "path",
389
+ "required": true,
390
+ "schema": {
391
+ "type": "string"
392
+ }
393
+ }
394
+ ],
395
+ "responses": {
396
+ "200": {
397
+ "description": "Binary export result.",
398
+ "headers": {
399
+ "Content-Disposition": {
400
+ "style": "simple",
401
+ "schema": {
402
+ "pattern": "attachment; filename='[^']+'",
403
+ "type": "string",
404
+ "example": "attachment; filename='result.csv'"
405
+ }
406
+ }
407
+ },
408
+ "content": {
409
+ "text/csv": {},
410
+ "application/vnd.apache.arrow.stream": {},
411
+ "application/vnd.apache.arrow.file": {}
412
+ }
413
+ },
414
+ "202": {
415
+ "description": "Request is accepted, provided exportId exists, but export is not yet ready.",
416
+ "content": {
417
+ "text/csv": {
418
+ "schema": {
419
+ "type": "string",
420
+ "format": "binary"
421
+ }
422
+ },
423
+ "application/vnd.apache.arrow.stream": {
424
+ "schema": {
425
+ "type": "string",
426
+ "format": "binary"
427
+ }
428
+ },
429
+ "application/vnd.apache.arrow.file": {
430
+ "schema": {
431
+ "type": "string",
432
+ "format": "binary"
433
+ }
434
+ }
435
+ }
436
+ }
437
+ },
438
+ "x-gdc-security-info": {
439
+ "permissions": ["EXPORT_TABULAR"],
440
+ "description": "Minimal permission required to use this endpoint."
441
+ }
442
+ }
284
443
  }
285
444
  },
286
445
  "components": {
@@ -495,7 +654,7 @@
495
654
  },
496
655
  "visualizationObjectCustomFilters": {
497
656
  "type": "array",
498
- "description": "Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. (HTML/PDF only)",
657
+ "description": "Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given.",
499
658
  "example": "[{\"negativeAttributeFilter\":{\"displayForm\":{\"identifier\":{\"id\":\"products.category\",\"type\":\"label\"}},\"notIn\":{\"values\":[\"Books\"]}}}]",
500
659
  "items": {
501
660
  "type": "object"
@@ -511,6 +670,847 @@
511
670
  }
512
671
  },
513
672
  "description": "Export request object describing the export properties and overrides for tabular exports."
673
+ },
674
+ "AFM": {
675
+ "required": ["attributes", "filters", "measures"],
676
+ "type": "object",
677
+ "properties": {
678
+ "attributes": {
679
+ "type": "array",
680
+ "description": "Attributes to be used in the computation.",
681
+ "items": {
682
+ "$ref": "#/components/schemas/AttributeItem"
683
+ }
684
+ },
685
+ "filters": {
686
+ "type": "array",
687
+ "description": "Various filter types to filter the execution result.",
688
+ "items": {
689
+ "$ref": "#/components/schemas/FilterDefinition"
690
+ }
691
+ },
692
+ "measures": {
693
+ "type": "array",
694
+ "description": "Metrics to be computed.",
695
+ "items": {
696
+ "$ref": "#/components/schemas/MeasureItem"
697
+ }
698
+ },
699
+ "auxMeasures": {
700
+ "type": "array",
701
+ "description": "Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.",
702
+ "items": {
703
+ "$ref": "#/components/schemas/MeasureItem"
704
+ }
705
+ }
706
+ },
707
+ "description": "Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics."
708
+ },
709
+ "AbsoluteDateFilter": {
710
+ "required": ["absoluteDateFilter"],
711
+ "type": "object",
712
+ "properties": {
713
+ "absoluteDateFilter": {
714
+ "required": ["from", "to", "dataset"],
715
+ "type": "object",
716
+ "properties": {
717
+ "from": {
718
+ "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$",
719
+ "type": "string",
720
+ "example": "2020-07-01 18:23"
721
+ },
722
+ "to": {
723
+ "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$",
724
+ "type": "string",
725
+ "example": "2020-07-16 23:59"
726
+ },
727
+ "localIdentifier": {
728
+ "type": "string"
729
+ },
730
+ "applyOnResult": {
731
+ "type": "boolean"
732
+ },
733
+ "dataset": {
734
+ "$ref": "#/components/schemas/AfmObjectIdentifierDataset"
735
+ }
736
+ }
737
+ }
738
+ },
739
+ "description": "A datetime filter specifying exact from and to values."
740
+ },
741
+ "AbstractMeasureValueFilter": {
742
+ "type": "object",
743
+ "oneOf": [
744
+ {
745
+ "$ref": "#/components/schemas/ComparisonMeasureValueFilter"
746
+ },
747
+ {
748
+ "$ref": "#/components/schemas/RangeMeasureValueFilter"
749
+ },
750
+ {
751
+ "$ref": "#/components/schemas/RankingFilter"
752
+ }
753
+ ]
754
+ },
755
+ "AfmIdentifier": {
756
+ "type": "object",
757
+ "description": "Reference to the attribute label to which the filter should be applied.",
758
+ "oneOf": [
759
+ {
760
+ "$ref": "#/components/schemas/AfmObjectIdentifier"
761
+ },
762
+ {
763
+ "$ref": "#/components/schemas/AfmLocalIdentifier"
764
+ }
765
+ ]
766
+ },
767
+ "AfmLocalIdentifier": {
768
+ "required": ["localIdentifier"],
769
+ "type": "object",
770
+ "properties": {
771
+ "localIdentifier": {
772
+ "pattern": "^[.a-zA-Z0-9_-]+$",
773
+ "type": "string",
774
+ "example": "sampleAutoGenerated0123_ID"
775
+ }
776
+ }
777
+ },
778
+ "AfmObjectIdentifier": {
779
+ "required": ["identifier"],
780
+ "type": "object",
781
+ "properties": {
782
+ "identifier": {
783
+ "required": ["type", "id"],
784
+ "type": "object",
785
+ "properties": {
786
+ "type": {
787
+ "type": "string",
788
+ "example": "fact",
789
+ "enum": [
790
+ "analyticalDashboard",
791
+ "attribute",
792
+ "dashboardPlugin",
793
+ "dataset",
794
+ "fact",
795
+ "label",
796
+ "metric",
797
+ "prompt",
798
+ "visualizationObject",
799
+ "filterContext"
800
+ ]
801
+ },
802
+ "id": {
803
+ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
804
+ "type": "string",
805
+ "example": "sample_item.price"
806
+ }
807
+ }
808
+ }
809
+ },
810
+ "description": "ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers."
811
+ },
812
+ "AfmObjectIdentifierAttribute": {
813
+ "required": ["identifier"],
814
+ "type": "object",
815
+ "properties": {
816
+ "identifier": {
817
+ "required": ["id", "type"],
818
+ "type": "object",
819
+ "properties": {
820
+ "id": {
821
+ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
822
+ "type": "string",
823
+ "example": "sample_item.price"
824
+ },
825
+ "type": {
826
+ "type": "string",
827
+ "enum": ["attribute"]
828
+ }
829
+ }
830
+ }
831
+ },
832
+ "description": "Reference to the date attribute to use."
833
+ },
834
+ "AfmObjectIdentifierCore": {
835
+ "required": ["identifier"],
836
+ "type": "object",
837
+ "properties": {
838
+ "identifier": {
839
+ "required": ["id", "type"],
840
+ "type": "object",
841
+ "properties": {
842
+ "id": {
843
+ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
844
+ "type": "string",
845
+ "example": "sample_item.price"
846
+ },
847
+ "type": {
848
+ "type": "string",
849
+ "enum": ["attribute", "label", "fact", "metric"]
850
+ }
851
+ }
852
+ }
853
+ },
854
+ "description": "Reference to the metric, fact or attribute object to use for the metric."
855
+ },
856
+ "AfmObjectIdentifierDataset": {
857
+ "required": ["identifier"],
858
+ "type": "object",
859
+ "properties": {
860
+ "identifier": {
861
+ "required": ["id", "type"],
862
+ "type": "object",
863
+ "properties": {
864
+ "id": {
865
+ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
866
+ "type": "string",
867
+ "example": "sample_item.price"
868
+ },
869
+ "type": {
870
+ "type": "string",
871
+ "enum": ["dataset"]
872
+ }
873
+ }
874
+ }
875
+ },
876
+ "description": "Reference to the date dataset to which the filter should be applied."
877
+ },
878
+ "AfmObjectIdentifierLabel": {
879
+ "required": ["identifier"],
880
+ "type": "object",
881
+ "properties": {
882
+ "identifier": {
883
+ "required": ["type", "id"],
884
+ "type": "object",
885
+ "properties": {
886
+ "type": {
887
+ "type": "string",
888
+ "enum": ["label"]
889
+ },
890
+ "id": {
891
+ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
892
+ "type": "string",
893
+ "example": "sample_item.price"
894
+ }
895
+ }
896
+ }
897
+ }
898
+ },
899
+ "ArithmeticMeasureDefinition": {
900
+ "required": ["arithmeticMeasure"],
901
+ "type": "object",
902
+ "properties": {
903
+ "arithmeticMeasure": {
904
+ "required": ["measureIdentifiers", "operator"],
905
+ "type": "object",
906
+ "properties": {
907
+ "measureIdentifiers": {
908
+ "type": "array",
909
+ "description": "List of metrics to apply arithmetic operation by chosen operator.",
910
+ "items": {
911
+ "$ref": "#/components/schemas/AfmLocalIdentifier"
912
+ }
913
+ },
914
+ "operator": {
915
+ "type": "string",
916
+ "description": "Arithmetic operator describing operation between metrics.",
917
+ "example": "SUM",
918
+ "enum": ["SUM", "DIFFERENCE", "MULTIPLICATION", "RATIO", "CHANGE"]
919
+ }
920
+ }
921
+ }
922
+ },
923
+ "description": "Metric representing arithmetics between other metrics."
924
+ },
925
+ "AttributeFilter": {
926
+ "type": "object",
927
+ "description": "Abstract filter definition type attributes",
928
+ "oneOf": [
929
+ {
930
+ "$ref": "#/components/schemas/NegativeAttributeFilter"
931
+ },
932
+ {
933
+ "$ref": "#/components/schemas/PositiveAttributeFilter"
934
+ }
935
+ ]
936
+ },
937
+ "AttributeFilterElements": {
938
+ "required": ["values"],
939
+ "type": "object",
940
+ "properties": {
941
+ "values": {
942
+ "uniqueItems": true,
943
+ "type": "array",
944
+ "description": "Set of label values.",
945
+ "example": ["value1", "value2"],
946
+ "items": {
947
+ "type": "string",
948
+ "nullable": true
949
+ }
950
+ }
951
+ },
952
+ "description": "Filter on specific set of label values."
953
+ },
954
+ "AttributeItem": {
955
+ "required": ["label", "localIdentifier"],
956
+ "type": "object",
957
+ "properties": {
958
+ "localIdentifier": {
959
+ "pattern": "^[.a-zA-Z0-9_-]+$",
960
+ "type": "string",
961
+ "description": "Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.",
962
+ "example": "attribute_1"
963
+ },
964
+ "label": {
965
+ "$ref": "#/components/schemas/AfmObjectIdentifierLabel"
966
+ },
967
+ "showAllValues": {
968
+ "type": "boolean",
969
+ "description": "Indicates whether to show all values of given attribute even if the data bound to those values is not available.",
970
+ "default": false
971
+ }
972
+ }
973
+ },
974
+ "ComparisonMeasureValueFilter": {
975
+ "required": ["comparisonMeasureValueFilter"],
976
+ "type": "object",
977
+ "properties": {
978
+ "comparisonMeasureValueFilter": {
979
+ "required": ["operator", "value", "measure"],
980
+ "type": "object",
981
+ "properties": {
982
+ "dimensionality": {
983
+ "type": "array",
984
+ "description": "References to the attributes to be used when filtering.",
985
+ "items": {
986
+ "$ref": "#/components/schemas/AfmIdentifier"
987
+ }
988
+ },
989
+ "treatNullValuesAs": {
990
+ "type": "number",
991
+ "description": "A value that will be substituted for null values in the metric for the comparisons.",
992
+ "example": 0
993
+ },
994
+ "operator": {
995
+ "type": "string",
996
+ "example": "GREATER_THAN",
997
+ "enum": [
998
+ "GREATER_THAN",
999
+ "GREATER_THAN_OR_EQUAL_TO",
1000
+ "LESS_THAN",
1001
+ "LESS_THAN_OR_EQUAL_TO",
1002
+ "EQUAL_TO",
1003
+ "NOT_EQUAL_TO"
1004
+ ]
1005
+ },
1006
+ "value": {
1007
+ "type": "number",
1008
+ "example": 1327
1009
+ },
1010
+ "localIdentifier": {
1011
+ "type": "string"
1012
+ },
1013
+ "applyOnResult": {
1014
+ "type": "boolean"
1015
+ },
1016
+ "measure": {
1017
+ "$ref": "#/components/schemas/AfmIdentifier"
1018
+ }
1019
+ }
1020
+ }
1021
+ },
1022
+ "description": "Filter the result by comparing specified metric to given constant value, using given comparison operator."
1023
+ },
1024
+ "DateFilter": {
1025
+ "type": "object",
1026
+ "description": "Abstract filter definition type for dates.",
1027
+ "oneOf": [
1028
+ {
1029
+ "$ref": "#/components/schemas/AbsoluteDateFilter"
1030
+ },
1031
+ {
1032
+ "$ref": "#/components/schemas/RelativeDateFilter"
1033
+ }
1034
+ ]
1035
+ },
1036
+ "FilterDefinition": {
1037
+ "type": "object",
1038
+ "description": "Abstract filter definition type",
1039
+ "oneOf": [
1040
+ {
1041
+ "$ref": "#/components/schemas/InlineFilterDefinition"
1042
+ },
1043
+ {
1044
+ "$ref": "#/components/schemas/RankingFilter"
1045
+ },
1046
+ {
1047
+ "$ref": "#/components/schemas/ComparisonMeasureValueFilter"
1048
+ },
1049
+ {
1050
+ "$ref": "#/components/schemas/RangeMeasureValueFilter"
1051
+ },
1052
+ {
1053
+ "$ref": "#/components/schemas/AbsoluteDateFilter"
1054
+ },
1055
+ {
1056
+ "$ref": "#/components/schemas/RelativeDateFilter"
1057
+ },
1058
+ {
1059
+ "$ref": "#/components/schemas/NegativeAttributeFilter"
1060
+ },
1061
+ {
1062
+ "$ref": "#/components/schemas/PositiveAttributeFilter"
1063
+ }
1064
+ ]
1065
+ },
1066
+ "FilterDefinitionForSimpleMeasure": {
1067
+ "type": "object",
1068
+ "description": "Abstract filter definition type for simple metric.",
1069
+ "oneOf": [
1070
+ {
1071
+ "$ref": "#/components/schemas/DateFilter"
1072
+ },
1073
+ {
1074
+ "$ref": "#/components/schemas/AttributeFilter"
1075
+ }
1076
+ ]
1077
+ },
1078
+ "InlineFilterDefinition": {
1079
+ "required": ["inline"],
1080
+ "type": "object",
1081
+ "properties": {
1082
+ "inline": {
1083
+ "required": ["filter"],
1084
+ "type": "object",
1085
+ "properties": {
1086
+ "filter": {
1087
+ "type": "string",
1088
+ "description": "MAQL query representing the filter."
1089
+ },
1090
+ "localIdentifier": {
1091
+ "type": "string"
1092
+ },
1093
+ "applyOnResult": {
1094
+ "type": "boolean"
1095
+ }
1096
+ }
1097
+ }
1098
+ },
1099
+ "description": "Filter in form of direct MAQL query."
1100
+ },
1101
+ "InlineMeasureDefinition": {
1102
+ "required": ["inline"],
1103
+ "type": "object",
1104
+ "properties": {
1105
+ "inline": {
1106
+ "required": ["maql"],
1107
+ "type": "object",
1108
+ "properties": {
1109
+ "maql": {
1110
+ "type": "string",
1111
+ "description": "MAQL query defining the metric."
1112
+ }
1113
+ }
1114
+ }
1115
+ },
1116
+ "description": "Metric defined by the raw MAQL query."
1117
+ },
1118
+ "MeasureDefinition": {
1119
+ "type": "object",
1120
+ "description": "Abstract metric definition type",
1121
+ "oneOf": [
1122
+ {
1123
+ "$ref": "#/components/schemas/InlineMeasureDefinition"
1124
+ },
1125
+ {
1126
+ "$ref": "#/components/schemas/ArithmeticMeasureDefinition"
1127
+ },
1128
+ {
1129
+ "$ref": "#/components/schemas/SimpleMeasureDefinition"
1130
+ },
1131
+ {
1132
+ "$ref": "#/components/schemas/PopMeasureDefinition"
1133
+ }
1134
+ ]
1135
+ },
1136
+ "MeasureItem": {
1137
+ "required": ["definition", "localIdentifier"],
1138
+ "type": "object",
1139
+ "properties": {
1140
+ "localIdentifier": {
1141
+ "pattern": "^[.a-zA-Z0-9_-]+$",
1142
+ "type": "string",
1143
+ "description": "Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.",
1144
+ "example": "metric_1"
1145
+ },
1146
+ "definition": {
1147
+ "$ref": "#/components/schemas/MeasureDefinition"
1148
+ }
1149
+ },
1150
+ "description": "Metric is a quantity that is calculated from the data."
1151
+ },
1152
+ "MeasureValueFilter": {
1153
+ "type": "object",
1154
+ "description": "Abstract filter definition type filtering by the value of the metric.",
1155
+ "oneOf": [
1156
+ {
1157
+ "$ref": "#/components/schemas/ComparisonMeasureValueFilter"
1158
+ },
1159
+ {
1160
+ "$ref": "#/components/schemas/RangeMeasureValueFilter"
1161
+ }
1162
+ ]
1163
+ },
1164
+ "NegativeAttributeFilter": {
1165
+ "required": ["negativeAttributeFilter"],
1166
+ "type": "object",
1167
+ "properties": {
1168
+ "negativeAttributeFilter": {
1169
+ "required": ["notIn", "label"],
1170
+ "type": "object",
1171
+ "properties": {
1172
+ "notIn": {
1173
+ "$ref": "#/components/schemas/AttributeFilterElements"
1174
+ },
1175
+ "localIdentifier": {
1176
+ "type": "string"
1177
+ },
1178
+ "applyOnResult": {
1179
+ "type": "boolean"
1180
+ },
1181
+ "label": {
1182
+ "$ref": "#/components/schemas/AfmIdentifier"
1183
+ }
1184
+ }
1185
+ }
1186
+ },
1187
+ "description": "Filter able to limit element values by label and related selected negated elements."
1188
+ },
1189
+ "PopDataset": {
1190
+ "required": ["dataset", "periodsAgo"],
1191
+ "type": "object",
1192
+ "properties": {
1193
+ "dataset": {
1194
+ "$ref": "#/components/schemas/AfmObjectIdentifierDataset"
1195
+ },
1196
+ "periodsAgo": {
1197
+ "type": "integer",
1198
+ "description": "Number of periods ago to calculate the previous period for.",
1199
+ "format": "int32",
1200
+ "example": 1
1201
+ }
1202
+ },
1203
+ "description": "Combination of the date data set to use and how many periods ago to calculate the previous period for."
1204
+ },
1205
+ "PopDatasetMeasureDefinition": {
1206
+ "required": ["previousPeriodMeasure"],
1207
+ "type": "object",
1208
+ "properties": {
1209
+ "previousPeriodMeasure": {
1210
+ "required": ["dateDatasets", "measureIdentifier"],
1211
+ "type": "object",
1212
+ "properties": {
1213
+ "measureIdentifier": {
1214
+ "$ref": "#/components/schemas/AfmLocalIdentifier"
1215
+ },
1216
+ "dateDatasets": {
1217
+ "type": "array",
1218
+ "description": "Specification of which date data sets to use for determining the period to calculate the previous period for.",
1219
+ "items": {
1220
+ "$ref": "#/components/schemas/PopDataset"
1221
+ }
1222
+ }
1223
+ }
1224
+ }
1225
+ },
1226
+ "description": "Previous period type of metric."
1227
+ },
1228
+ "PopDate": {
1229
+ "required": ["attribute", "periodsAgo"],
1230
+ "type": "object",
1231
+ "properties": {
1232
+ "attribute": {
1233
+ "$ref": "#/components/schemas/AfmObjectIdentifierAttribute"
1234
+ },
1235
+ "periodsAgo": {
1236
+ "type": "integer",
1237
+ "description": "Number of periods ago to calculate the previous period for.",
1238
+ "format": "int32",
1239
+ "example": 1
1240
+ }
1241
+ },
1242
+ "description": "Combination of the date attribute to use and how many periods ago to calculate the PoP for."
1243
+ },
1244
+ "PopDateMeasureDefinition": {
1245
+ "required": ["overPeriodMeasure"],
1246
+ "type": "object",
1247
+ "properties": {
1248
+ "overPeriodMeasure": {
1249
+ "required": ["dateAttributes", "measureIdentifier"],
1250
+ "type": "object",
1251
+ "properties": {
1252
+ "measureIdentifier": {
1253
+ "$ref": "#/components/schemas/AfmLocalIdentifier"
1254
+ },
1255
+ "dateAttributes": {
1256
+ "type": "array",
1257
+ "description": "Attributes to use for determining the period to calculate the PoP for.",
1258
+ "items": {
1259
+ "$ref": "#/components/schemas/PopDate"
1260
+ }
1261
+ }
1262
+ }
1263
+ }
1264
+ },
1265
+ "description": "Period over period type of metric."
1266
+ },
1267
+ "PopMeasureDefinition": {
1268
+ "type": "object",
1269
+ "oneOf": [
1270
+ {
1271
+ "$ref": "#/components/schemas/PopDatasetMeasureDefinition"
1272
+ },
1273
+ {
1274
+ "$ref": "#/components/schemas/PopDateMeasureDefinition"
1275
+ }
1276
+ ]
1277
+ },
1278
+ "PositiveAttributeFilter": {
1279
+ "required": ["positiveAttributeFilter"],
1280
+ "type": "object",
1281
+ "properties": {
1282
+ "positiveAttributeFilter": {
1283
+ "required": ["in", "label"],
1284
+ "type": "object",
1285
+ "properties": {
1286
+ "in": {
1287
+ "$ref": "#/components/schemas/AttributeFilterElements"
1288
+ },
1289
+ "localIdentifier": {
1290
+ "type": "string"
1291
+ },
1292
+ "applyOnResult": {
1293
+ "type": "boolean"
1294
+ },
1295
+ "label": {
1296
+ "$ref": "#/components/schemas/AfmIdentifier"
1297
+ }
1298
+ }
1299
+ }
1300
+ },
1301
+ "description": "Filter able to limit element values by label and related selected elements."
1302
+ },
1303
+ "RangeMeasureValueFilter": {
1304
+ "required": ["rangeMeasureValueFilter"],
1305
+ "type": "object",
1306
+ "properties": {
1307
+ "rangeMeasureValueFilter": {
1308
+ "required": ["from", "operator", "to", "measure"],
1309
+ "type": "object",
1310
+ "properties": {
1311
+ "dimensionality": {
1312
+ "type": "array",
1313
+ "description": "References to the attributes to be used when filtering.",
1314
+ "items": {
1315
+ "$ref": "#/components/schemas/AfmIdentifier"
1316
+ }
1317
+ },
1318
+ "treatNullValuesAs": {
1319
+ "type": "number",
1320
+ "description": "A value that will be substituted for null values in the metric for the comparisons.",
1321
+ "example": 0
1322
+ },
1323
+ "operator": {
1324
+ "type": "string",
1325
+ "example": "BETWEEN",
1326
+ "enum": ["BETWEEN", "NOT_BETWEEN"]
1327
+ },
1328
+ "from": {
1329
+ "type": "number",
1330
+ "example": 100
1331
+ },
1332
+ "to": {
1333
+ "type": "number",
1334
+ "example": 999
1335
+ },
1336
+ "localIdentifier": {
1337
+ "type": "string"
1338
+ },
1339
+ "applyOnResult": {
1340
+ "type": "boolean"
1341
+ },
1342
+ "measure": {
1343
+ "$ref": "#/components/schemas/AfmIdentifier"
1344
+ }
1345
+ }
1346
+ }
1347
+ },
1348
+ "description": "Filter the result by comparing specified metric to given range of values."
1349
+ },
1350
+ "RankingFilter": {
1351
+ "required": ["rankingFilter"],
1352
+ "type": "object",
1353
+ "properties": {
1354
+ "rankingFilter": {
1355
+ "required": ["measures", "operator", "value"],
1356
+ "type": "object",
1357
+ "properties": {
1358
+ "dimensionality": {
1359
+ "type": "array",
1360
+ "description": "References to the attributes to be used when filtering.",
1361
+ "items": {
1362
+ "$ref": "#/components/schemas/AfmIdentifier"
1363
+ }
1364
+ },
1365
+ "measures": {
1366
+ "type": "array",
1367
+ "description": "References to the metrics to be used when filtering.",
1368
+ "items": {
1369
+ "$ref": "#/components/schemas/AfmIdentifier"
1370
+ }
1371
+ },
1372
+ "operator": {
1373
+ "type": "string",
1374
+ "description": "The type of ranking to use, TOP or BOTTOM.",
1375
+ "enum": ["TOP", "BOTTOM"]
1376
+ },
1377
+ "value": {
1378
+ "type": "integer",
1379
+ "description": "Number of top/bottom values to filter.",
1380
+ "format": "int32",
1381
+ "example": 5
1382
+ },
1383
+ "localIdentifier": {
1384
+ "type": "string"
1385
+ },
1386
+ "applyOnResult": {
1387
+ "type": "boolean"
1388
+ }
1389
+ }
1390
+ }
1391
+ },
1392
+ "description": "Filter the result on top/bottom N values according to given metric(s)."
1393
+ },
1394
+ "RawExportRequest": {
1395
+ "required": ["execution", "fileName", "format"],
1396
+ "type": "object",
1397
+ "properties": {
1398
+ "format": {
1399
+ "type": "string",
1400
+ "description": "Requested resulting file type.",
1401
+ "example": "CSV",
1402
+ "enum": ["ARROW_FILE", "ARROW_STREAM", "CSV"]
1403
+ },
1404
+ "execution": {
1405
+ "$ref": "#/components/schemas/AFM"
1406
+ },
1407
+ "fileName": {
1408
+ "type": "string",
1409
+ "description": "Filename of downloaded file without extension.",
1410
+ "example": "result"
1411
+ }
1412
+ },
1413
+ "description": "Export request object describing the export properties and overrides for raw exports."
1414
+ },
1415
+ "RelativeDateFilter": {
1416
+ "required": ["relativeDateFilter"],
1417
+ "type": "object",
1418
+ "properties": {
1419
+ "relativeDateFilter": {
1420
+ "required": ["from", "granularity", "to", "dataset"],
1421
+ "type": "object",
1422
+ "properties": {
1423
+ "granularity": {
1424
+ "type": "string",
1425
+ "description": "Date granularity specifying particular date attribute in given dimension.",
1426
+ "example": "DAY",
1427
+ "enum": [
1428
+ "MINUTE",
1429
+ "HOUR",
1430
+ "DAY",
1431
+ "WEEK",
1432
+ "MONTH",
1433
+ "QUARTER",
1434
+ "YEAR",
1435
+ "MINUTE_OF_HOUR",
1436
+ "HOUR_OF_DAY",
1437
+ "DAY_OF_WEEK",
1438
+ "DAY_OF_MONTH",
1439
+ "DAY_OF_YEAR",
1440
+ "WEEK_OF_YEAR",
1441
+ "MONTH_OF_YEAR",
1442
+ "QUARTER_OF_YEAR"
1443
+ ]
1444
+ },
1445
+ "from": {
1446
+ "type": "integer",
1447
+ "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').",
1448
+ "format": "int32",
1449
+ "example": -6
1450
+ },
1451
+ "to": {
1452
+ "type": "integer",
1453
+ "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, ...).",
1454
+ "format": "int32",
1455
+ "example": 0
1456
+ },
1457
+ "localIdentifier": {
1458
+ "type": "string"
1459
+ },
1460
+ "applyOnResult": {
1461
+ "type": "boolean"
1462
+ },
1463
+ "dataset": {
1464
+ "$ref": "#/components/schemas/AfmObjectIdentifierDataset"
1465
+ }
1466
+ }
1467
+ }
1468
+ },
1469
+ "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."
1470
+ },
1471
+ "SimpleMeasureDefinition": {
1472
+ "required": ["measure"],
1473
+ "type": "object",
1474
+ "properties": {
1475
+ "measure": {
1476
+ "required": ["item"],
1477
+ "type": "object",
1478
+ "properties": {
1479
+ "item": {
1480
+ "$ref": "#/components/schemas/AfmObjectIdentifierCore"
1481
+ },
1482
+ "aggregation": {
1483
+ "type": "string",
1484
+ "description": "Definition of aggregation type of the metric.",
1485
+ "example": "SUM",
1486
+ "enum": [
1487
+ "SUM",
1488
+ "COUNT",
1489
+ "AVG",
1490
+ "MIN",
1491
+ "MAX",
1492
+ "MEDIAN",
1493
+ "RUNSUM",
1494
+ "APPROXIMATE_COUNT"
1495
+ ]
1496
+ },
1497
+ "computeRatio": {
1498
+ "type": "boolean",
1499
+ "description": "If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).",
1500
+ "example": true,
1501
+ "default": false
1502
+ },
1503
+ "filters": {
1504
+ "type": "array",
1505
+ "description": "Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.",
1506
+ "items": {
1507
+ "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure"
1508
+ }
1509
+ }
1510
+ }
1511
+ }
1512
+ },
1513
+ "description": "Metric defined by referencing a MAQL metric or an LDM fact object with aggregation."
514
1514
  }
515
1515
  }
516
1516
  }