@gooddata/api-client-tiger 10.1.0-alpha.3 → 10.1.0-alpha.4

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 (41) hide show
  1. package/esm/__version.d.ts +1 -1
  2. package/esm/__version.js +1 -1
  3. package/esm/api-client-tiger.d.ts +2255 -965
  4. package/esm/generated/afm-rest-api/api.d.ts +440 -2
  5. package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
  6. package/esm/generated/afm-rest-api/api.js +363 -0
  7. package/esm/generated/afm-rest-api/api.js.map +1 -1
  8. package/esm/generated/afm-rest-api/openapi-spec.json +828 -625
  9. package/esm/generated/export-json-api/api.d.ts +89 -89
  10. package/esm/generated/export-json-api/api.d.ts.map +1 -1
  11. package/esm/generated/export-json-api/api.js +42 -42
  12. package/esm/generated/export-json-api/api.js.map +1 -1
  13. package/esm/generated/export-json-api/openapi-spec.json +5 -5
  14. package/esm/generated/metadata-json-api/api.d.ts +1508 -901
  15. package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
  16. package/esm/generated/metadata-json-api/api.js +647 -18
  17. package/esm/generated/metadata-json-api/api.js.map +1 -1
  18. package/esm/generated/metadata-json-api/openapi-spec.json +4876 -4845
  19. package/esm/generated/result-json-api/api.d.ts +157 -0
  20. package/esm/generated/result-json-api/api.d.ts.map +1 -1
  21. package/esm/generated/result-json-api/api.js +139 -0
  22. package/esm/generated/result-json-api/api.js.map +1 -1
  23. package/esm/generated/result-json-api/openapi-spec.json +73 -0
  24. package/esm/generated/scan-json-api/api.d.ts +343 -0
  25. package/esm/generated/scan-json-api/api.d.ts.map +1 -1
  26. package/esm/generated/scan-json-api/api.js +102 -0
  27. package/esm/generated/scan-json-api/api.js.map +1 -1
  28. package/esm/generated/scan-json-api/openapi-spec.json +257 -0
  29. package/esm/index.d.ts +3 -3
  30. package/esm/index.d.ts.map +1 -1
  31. package/esm/index.js +3 -2
  32. package/esm/index.js.map +1 -1
  33. package/esm/metadataUtilities.d.ts +2 -2
  34. package/esm/metadataUtilities.d.ts.map +1 -1
  35. package/esm/metadataUtilities.js +1 -1
  36. package/esm/metadataUtilities.js.map +1 -1
  37. package/esm/organizationUtilities.d.ts +2 -2
  38. package/esm/organizationUtilities.d.ts.map +1 -1
  39. package/esm/organizationUtilities.js +1 -1
  40. package/esm/organizationUtilities.js.map +1 -1
  41. package/package.json +3 -3
package/esm/generated/afm-rest-api/openapi-spec.json CHANGED
@@ -141,6 +141,58 @@
141
141
  }
142
142
  }
143
143
  },
144
+ "/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers": {
145
+ "post": {
146
+ "tags": ["Computation", "actions"],
147
+ "summary": "(EXPERIMENTAL) Compute key driver analysis",
148
+ "description": "(EXPERIMENTAL) Computes key driver analysis for the provided execution definition.",
149
+ "operationId": "keyDriverAnalysis",
150
+ "parameters": [
151
+ {
152
+ "name": "workspaceId",
153
+ "in": "path",
154
+ "description": "Workspace identifier",
155
+ "required": true,
156
+ "schema": {
157
+ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
158
+ "type": "string"
159
+ }
160
+ },
161
+ {
162
+ "name": "skip-cache",
163
+ "in": "header",
164
+ "description": "Ignore all caches during execution of current request.",
165
+ "required": false,
166
+ "schema": {
167
+ "type": "boolean",
168
+ "default": false
169
+ }
170
+ }
171
+ ],
172
+ "requestBody": {
173
+ "content": {
174
+ "application/json": {
175
+ "schema": {
176
+ "$ref": "#/components/schemas/KeyDriversRequest"
177
+ }
178
+ }
179
+ },
180
+ "required": true
181
+ },
182
+ "responses": {
183
+ "200": {
184
+ "description": "OK",
185
+ "content": {
186
+ "application/json": {
187
+ "schema": {
188
+ "$ref": "#/components/schemas/KeyDriversResponse"
189
+ }
190
+ }
191
+ }
192
+ }
193
+ }
194
+ }
195
+ },
144
196
  "/api/v1/actions/workspaces/{workspaceId}/execution/collectLabelElements": {
145
197
  "post": {
146
198
  "tags": ["Computation", "actions"],
@@ -573,6 +625,66 @@
573
625
  }
574
626
  }
575
627
  },
628
+ "/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers/result/{resultId}": {
629
+ "get": {
630
+ "tags": ["Computation", "actions"],
631
+ "summary": "(EXPERIMENTAL) Get key driver analysis result",
632
+ "description": "(EXPERIMENTAL) Gets key driver analysis.",
633
+ "operationId": "keyDriverAnalysisResult",
634
+ "parameters": [
635
+ {
636
+ "name": "workspaceId",
637
+ "in": "path",
638
+ "description": "Workspace identifier",
639
+ "required": true,
640
+ "schema": {
641
+ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
642
+ "type": "string"
643
+ }
644
+ },
645
+ {
646
+ "name": "resultId",
647
+ "in": "path",
648
+ "description": "Result ID",
649
+ "required": true,
650
+ "schema": {
651
+ "type": "string"
652
+ },
653
+ "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781"
654
+ },
655
+ {
656
+ "name": "offset",
657
+ "in": "query",
658
+ "required": false,
659
+ "schema": {
660
+ "type": "integer",
661
+ "format": "int32"
662
+ }
663
+ },
664
+ {
665
+ "name": "limit",
666
+ "in": "query",
667
+ "required": false,
668
+ "schema": {
669
+ "type": "integer",
670
+ "format": "int32"
671
+ }
672
+ }
673
+ ],
674
+ "responses": {
675
+ "200": {
676
+ "description": "OK",
677
+ "content": {
678
+ "application/json": {
679
+ "schema": {
680
+ "$ref": "#/components/schemas/KeyDriversResult"
681
+ }
682
+ }
683
+ }
684
+ }
685
+ }
686
+ }
687
+ },
576
688
  "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata": {
577
689
  "get": {
578
690
  "tags": ["Computation", "actions"],
@@ -774,131 +886,6 @@
774
886
  }
775
887
  }
776
888
  },
777
- "AttributeFormat": {
778
- "required": ["locale", "pattern"],
779
- "type": "object",
780
- "properties": {
781
- "locale": {
782
- "type": "string",
783
- "description": "Format locale"
784
- },
785
- "pattern": {
786
- "type": "string",
787
- "description": "Format pattern"
788
- }
789
- }
790
- },
791
- "Element": {
792
- "required": ["primaryTitle", "title"],
793
- "type": "object",
794
- "properties": {
795
- "title": {
796
- "type": "string",
797
- "description": "Title of requested label.",
798
- "nullable": true
799
- },
800
- "primaryTitle": {
801
- "type": "string",
802
- "description": "Title of primary label of attribute owning requested label, null if the title is null or the primary label is excluded",
803
- "nullable": true
804
- }
805
- },
806
- "description": "List of returned elements."
807
- },
808
- "ElementsResponse": {
809
- "required": ["elements", "paging", "primaryLabel"],
810
- "type": "object",
811
- "properties": {
812
- "primaryLabel": {
813
- "$ref": "#/components/schemas/RestApiIdentifier"
814
- },
815
- "elements": {
816
- "type": "array",
817
- "description": "List of returned elements.",
818
- "items": {
819
- "$ref": "#/components/schemas/Element"
820
- }
821
- },
822
- "paging": {
823
- "$ref": "#/components/schemas/Paging"
824
- },
825
- "granularity": {
826
- "type": "string",
827
- "description": "Granularity of requested label in case of date attribute",
828
- "enum": [
829
- "MINUTE",
830
- "HOUR",
831
- "DAY",
832
- "WEEK",
833
- "MONTH",
834
- "QUARTER",
835
- "YEAR",
836
- "MINUTE_OF_HOUR",
837
- "HOUR_OF_DAY",
838
- "DAY_OF_WEEK",
839
- "DAY_OF_MONTH",
840
- "DAY_OF_YEAR",
841
- "WEEK_OF_YEAR",
842
- "MONTH_OF_YEAR",
843
- "QUARTER_OF_YEAR"
844
- ]
845
- },
846
- "format": {
847
- "$ref": "#/components/schemas/AttributeFormat"
848
- },
849
- "cacheId": {
850
- "type": "string",
851
- "description": "The client can use this in subsequent requests (like paging or search) to get results from the same point in time as the previous request. This is useful when the underlying data source has caches disabled and the client wants to avoid seeing inconsistent results and to also avoid excessive queries to the database itself."
852
- }
853
- },
854
- "description": "Entity holding list of sorted & filtered label elements, related primary label of attribute owning requested label and paging."
855
- },
856
- "Paging": {
857
- "required": ["count", "offset", "total"],
858
- "type": "object",
859
- "properties": {
860
- "total": {
861
- "type": "integer",
862
- "description": "Count of returnable items ignoring paging.",
863
- "format": "int32",
864
- "example": 100
865
- },
866
- "count": {
867
- "type": "integer",
868
- "description": "Count of items in this page.",
869
- "format": "int32",
870
- "example": 5
871
- },
872
- "offset": {
873
- "type": "integer",
874
- "description": "Offset of this page.",
875
- "format": "int32",
876
- "example": 10
877
- },
878
- "next": {
879
- "type": "string",
880
- "description": "Link to next page, or null if this is last page.",
881
- "example": "https://sample.gooddata.com/api/v1/actions/workspaces/sampleWorkspace/execution/collectLabelElements?label=sample.price&limit=5&offset=10"
882
- }
883
- },
884
- "description": "Current page description."
885
- },
886
- "RestApiIdentifier": {
887
- "required": ["id", "type"],
888
- "type": "object",
889
- "properties": {
890
- "id": {
891
- "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
892
- "type": "string",
893
- "example": "sample_item.price"
894
- },
895
- "type": {
896
- "type": "string",
897
- "example": "fact"
898
- }
899
- },
900
- "description": "Object identifier."
901
- },
902
889
  "AbsoluteDateFilter": {
903
890
  "required": ["absoluteDateFilter"],
904
891
  "type": "object",
@@ -928,41 +915,703 @@
928
915
  },
929
916
  "description": "A datetime filter specifying exact from and to values."
930
917
  },
931
- "AfmObjectIdentifierDataset": {
932
- "required": ["identifier"],
933
- "type": "object",
934
- "properties": {
935
- "identifier": {
936
- "required": ["id", "type"],
937
- "type": "object",
938
- "properties": {
939
- "id": {
940
- "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
941
- "type": "string",
942
- "example": "sample_item.price"
943
- },
944
- "type": {
945
- "type": "string",
946
- "enum": ["dataset"]
947
- }
948
- }
949
- }
950
- }
951
- },
952
- "DateFilter": {
918
+ "AfmIdentifier": {
953
919
  "type": "object",
954
- "description": "Abstract filter definition type for dates.",
955
920
  "oneOf": [
956
921
  {
957
- "$ref": "#/components/schemas/AbsoluteDateFilter"
922
+ "$ref": "#/components/schemas/AfmObjectIdentifier"
958
923
  },
959
924
  {
960
- "$ref": "#/components/schemas/RelativeDateFilter"
925
+ "$ref": "#/components/schemas/AfmLocalIdentifier"
961
926
  }
962
927
  ]
963
928
  },
964
- "DependsOn": {
965
- "required": ["label", "values"],
929
+ "AfmLocalIdentifier": {
930
+ "required": ["localIdentifier"],
931
+ "type": "object",
932
+ "properties": {
933
+ "localIdentifier": {
934
+ "pattern": "^[.a-zA-Z0-9_-]+$",
935
+ "type": "string",
936
+ "example": "sampleAutoGenerated0123_ID"
937
+ }
938
+ }
939
+ },
940
+ "AfmObjectIdentifier": {
941
+ "required": ["identifier"],
942
+ "type": "object",
943
+ "properties": {
944
+ "identifier": {
945
+ "required": ["type", "id"],
946
+ "type": "object",
947
+ "properties": {
948
+ "type": {
949
+ "type": "string",
950
+ "example": "fact",
951
+ "enum": [
952
+ "analyticalDashboard",
953
+ "attribute",
954
+ "dashboardPlugin",
955
+ "dataset",
956
+ "fact",
957
+ "label",
958
+ "metric",
959
+ "prompt",
960
+ "visualizationObject",
961
+ "filterContext"
962
+ ]
963
+ },
964
+ "id": {
965
+ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
966
+ "type": "string",
967
+ "example": "sample_item.price"
968
+ }
969
+ }
970
+ }
971
+ },
972
+ "description": "ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers."
973
+ },
974
+ "AfmObjectIdentifierAttribute": {
975
+ "required": ["identifier"],
976
+ "type": "object",
977
+ "properties": {
978
+ "identifier": {
979
+ "required": ["id", "type"],
980
+ "type": "object",
981
+ "properties": {
982
+ "id": {
983
+ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
984
+ "type": "string",
985
+ "example": "sample_item.price"
986
+ },
987
+ "type": {
988
+ "type": "string",
989
+ "enum": ["attribute"]
990
+ }
991
+ }
992
+ }
993
+ }
994
+ },
995
+ "AfmObjectIdentifierCore": {
996
+ "required": ["identifier"],
997
+ "type": "object",
998
+ "properties": {
999
+ "identifier": {
1000
+ "required": ["id", "type"],
1001
+ "type": "object",
1002
+ "properties": {
1003
+ "id": {
1004
+ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
1005
+ "type": "string",
1006
+ "example": "sample_item.price"
1007
+ },
1008
+ "type": {
1009
+ "type": "string",
1010
+ "enum": ["attribute", "label", "fact", "metric"]
1011
+ }
1012
+ }
1013
+ }
1014
+ }
1015
+ },
1016
+ "AfmObjectIdentifierDataset": {
1017
+ "required": ["identifier"],
1018
+ "type": "object",
1019
+ "properties": {
1020
+ "identifier": {
1021
+ "required": ["id", "type"],
1022
+ "type": "object",
1023
+ "properties": {
1024
+ "id": {
1025
+ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
1026
+ "type": "string",
1027
+ "example": "sample_item.price"
1028
+ },
1029
+ "type": {
1030
+ "type": "string",
1031
+ "enum": ["dataset"]
1032
+ }
1033
+ }
1034
+ }
1035
+ }
1036
+ },
1037
+ "AfmObjectIdentifierLabel": {
1038
+ "required": ["identifier"],
1039
+ "type": "object",
1040
+ "properties": {
1041
+ "identifier": {
1042
+ "required": ["type", "id"],
1043
+ "type": "object",
1044
+ "properties": {
1045
+ "type": {
1046
+ "type": "string",
1047
+ "enum": ["label"]
1048
+ },
1049
+ "id": {
1050
+ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
1051
+ "type": "string",
1052
+ "example": "sample_item.price"
1053
+ }
1054
+ }
1055
+ }
1056
+ }
1057
+ },
1058
+ "ArithmeticMeasureDefinition": {
1059
+ "required": ["arithmeticMeasure"],
1060
+ "type": "object",
1061
+ "properties": {
1062
+ "arithmeticMeasure": {
1063
+ "required": ["measureIdentifiers", "operator"],
1064
+ "type": "object",
1065
+ "properties": {
1066
+ "measureIdentifiers": {
1067
+ "type": "array",
1068
+ "description": "List of metrics to apply arithmetic operation by chosen operator.",
1069
+ "items": {
1070
+ "$ref": "#/components/schemas/AfmLocalIdentifier"
1071
+ }
1072
+ },
1073
+ "operator": {
1074
+ "type": "string",
1075
+ "description": "Arithmetic operator describing operation between metrics.",
1076
+ "example": "SUM",
1077
+ "enum": ["SUM", "DIFFERENCE", "MULTIPLICATION", "RATIO", "CHANGE"]
1078
+ }
1079
+ }
1080
+ }
1081
+ },
1082
+ "description": "Metric representing arithmetics between metrics."
1083
+ },
1084
+ "AttributeFilter": {
1085
+ "type": "object",
1086
+ "description": "Abstract filter definition type attributes",
1087
+ "oneOf": [
1088
+ {
1089
+ "$ref": "#/components/schemas/NegativeAttributeFilter"
1090
+ },
1091
+ {
1092
+ "$ref": "#/components/schemas/PositiveAttributeFilter"
1093
+ }
1094
+ ]
1095
+ },
1096
+ "AttributeFilterElements": {
1097
+ "required": ["values"],
1098
+ "type": "object",
1099
+ "properties": {
1100
+ "values": {
1101
+ "uniqueItems": true,
1102
+ "type": "array",
1103
+ "description": "Set of label values.",
1104
+ "example": ["value1", "value2"],
1105
+ "items": {
1106
+ "type": "string",
1107
+ "nullable": true
1108
+ }
1109
+ }
1110
+ },
1111
+ "description": "Filter on specific set of label values."
1112
+ },
1113
+ "DateFilter": {
1114
+ "type": "object",
1115
+ "description": "Abstract filter definition type for dates.",
1116
+ "oneOf": [
1117
+ {
1118
+ "$ref": "#/components/schemas/AbsoluteDateFilter"
1119
+ },
1120
+ {
1121
+ "$ref": "#/components/schemas/RelativeDateFilter"
1122
+ }
1123
+ ]
1124
+ },
1125
+ "FilterDefinitionForSimpleMeasure": {
1126
+ "type": "object",
1127
+ "description": "Abstract filter definition type for simple metric.",
1128
+ "oneOf": [
1129
+ {
1130
+ "$ref": "#/components/schemas/DateFilter"
1131
+ },
1132
+ {
1133
+ "$ref": "#/components/schemas/AttributeFilter"
1134
+ }
1135
+ ]
1136
+ },
1137
+ "InlineMeasureDefinition": {
1138
+ "required": ["inline"],
1139
+ "type": "object",
1140
+ "properties": {
1141
+ "inline": {
1142
+ "required": ["maql"],
1143
+ "type": "object",
1144
+ "properties": {
1145
+ "maql": {
1146
+ "type": "string"
1147
+ }
1148
+ }
1149
+ }
1150
+ },
1151
+ "description": "Metric defined by the raw MAQL query."
1152
+ },
1153
+ "KeyDriversRequest": {
1154
+ "required": ["metric"],
1155
+ "type": "object",
1156
+ "properties": {
1157
+ "metric": {
1158
+ "$ref": "#/components/schemas/MeasureItem"
1159
+ },
1160
+ "auxMetrics": {
1161
+ "type": "array",
1162
+ "description": "Additional metrics to be included in the computation, but excluded from the analysis.",
1163
+ "items": {
1164
+ "$ref": "#/components/schemas/MeasureItem"
1165
+ }
1166
+ },
1167
+ "sortDirection": {
1168
+ "type": "string",
1169
+ "description": "Sorting elements - ascending/descending order.",
1170
+ "default": "DESC",
1171
+ "enum": ["ASC", "DESC"]
1172
+ }
1173
+ }
1174
+ },
1175
+ "MeasureDefinition": {
1176
+ "type": "object",
1177
+ "description": "Abstract metric definition type",
1178
+ "oneOf": [
1179
+ {
1180
+ "$ref": "#/components/schemas/InlineMeasureDefinition"
1181
+ },
1182
+ {
1183
+ "$ref": "#/components/schemas/ArithmeticMeasureDefinition"
1184
+ },
1185
+ {
1186
+ "$ref": "#/components/schemas/SimpleMeasureDefinition"
1187
+ },
1188
+ {
1189
+ "$ref": "#/components/schemas/PopMeasureDefinition"
1190
+ }
1191
+ ]
1192
+ },
1193
+ "MeasureItem": {
1194
+ "required": ["definition", "localIdentifier"],
1195
+ "type": "object",
1196
+ "properties": {
1197
+ "localIdentifier": {
1198
+ "pattern": "^[.a-zA-Z0-9_-]+$",
1199
+ "type": "string",
1200
+ "example": "metric_1"
1201
+ },
1202
+ "definition": {
1203
+ "$ref": "#/components/schemas/MeasureDefinition"
1204
+ }
1205
+ }
1206
+ },
1207
+ "NegativeAttributeFilter": {
1208
+ "required": ["negativeAttributeFilter"],
1209
+ "type": "object",
1210
+ "properties": {
1211
+ "negativeAttributeFilter": {
1212
+ "required": ["notIn", "label"],
1213
+ "type": "object",
1214
+ "properties": {
1215
+ "notIn": {
1216
+ "$ref": "#/components/schemas/AttributeFilterElements"
1217
+ },
1218
+ "applyOnResult": {
1219
+ "type": "boolean"
1220
+ },
1221
+ "label": {
1222
+ "$ref": "#/components/schemas/AfmIdentifier"
1223
+ }
1224
+ }
1225
+ }
1226
+ },
1227
+ "description": "Filter able to limit element values by label and related selected negated elements."
1228
+ },
1229
+ "PopDataset": {
1230
+ "required": ["dataset", "periodsAgo"],
1231
+ "type": "object",
1232
+ "properties": {
1233
+ "dataset": {
1234
+ "$ref": "#/components/schemas/AfmObjectIdentifierDataset"
1235
+ },
1236
+ "periodsAgo": {
1237
+ "type": "integer",
1238
+ "format": "int32"
1239
+ }
1240
+ }
1241
+ },
1242
+ "PopDatasetMeasureDefinition": {
1243
+ "required": ["previousPeriodMeasure"],
1244
+ "type": "object",
1245
+ "properties": {
1246
+ "previousPeriodMeasure": {
1247
+ "required": ["dateDatasets", "measureIdentifier"],
1248
+ "type": "object",
1249
+ "properties": {
1250
+ "measureIdentifier": {
1251
+ "$ref": "#/components/schemas/AfmLocalIdentifier"
1252
+ },
1253
+ "dateDatasets": {
1254
+ "type": "array",
1255
+ "items": {
1256
+ "$ref": "#/components/schemas/PopDataset"
1257
+ }
1258
+ }
1259
+ }
1260
+ }
1261
+ },
1262
+ "description": "Previous period type of metric."
1263
+ },
1264
+ "PopDate": {
1265
+ "required": ["attribute", "periodsAgo"],
1266
+ "type": "object",
1267
+ "properties": {
1268
+ "attribute": {
1269
+ "$ref": "#/components/schemas/AfmObjectIdentifierAttribute"
1270
+ },
1271
+ "periodsAgo": {
1272
+ "type": "integer",
1273
+ "format": "int32"
1274
+ }
1275
+ }
1276
+ },
1277
+ "PopDateMeasureDefinition": {
1278
+ "required": ["overPeriodMeasure"],
1279
+ "type": "object",
1280
+ "properties": {
1281
+ "overPeriodMeasure": {
1282
+ "required": ["dateAttributes", "measureIdentifier"],
1283
+ "type": "object",
1284
+ "properties": {
1285
+ "measureIdentifier": {
1286
+ "$ref": "#/components/schemas/AfmLocalIdentifier"
1287
+ },
1288
+ "dateAttributes": {
1289
+ "type": "array",
1290
+ "items": {
1291
+ "$ref": "#/components/schemas/PopDate"
1292
+ }
1293
+ }
1294
+ }
1295
+ }
1296
+ },
1297
+ "description": "Period over period type of metric."
1298
+ },
1299
+ "PopMeasureDefinition": {
1300
+ "type": "object",
1301
+ "oneOf": [
1302
+ {
1303
+ "$ref": "#/components/schemas/PopDatasetMeasureDefinition"
1304
+ },
1305
+ {
1306
+ "$ref": "#/components/schemas/PopDateMeasureDefinition"
1307
+ }
1308
+ ]
1309
+ },
1310
+ "PositiveAttributeFilter": {
1311
+ "required": ["positiveAttributeFilter"],
1312
+ "type": "object",
1313
+ "properties": {
1314
+ "positiveAttributeFilter": {
1315
+ "required": ["in", "label"],
1316
+ "type": "object",
1317
+ "properties": {
1318
+ "in": {
1319
+ "$ref": "#/components/schemas/AttributeFilterElements"
1320
+ },
1321
+ "applyOnResult": {
1322
+ "type": "boolean"
1323
+ },
1324
+ "label": {
1325
+ "$ref": "#/components/schemas/AfmIdentifier"
1326
+ }
1327
+ }
1328
+ }
1329
+ },
1330
+ "description": "Filter able to limit element values by label and related selected elements."
1331
+ },
1332
+ "RelativeDateFilter": {
1333
+ "required": ["relativeDateFilter"],
1334
+ "type": "object",
1335
+ "properties": {
1336
+ "relativeDateFilter": {
1337
+ "required": ["from", "granularity", "to", "dataset"],
1338
+ "type": "object",
1339
+ "properties": {
1340
+ "granularity": {
1341
+ "type": "string",
1342
+ "description": "Date granularity specifying particular date attribute in given dimension.",
1343
+ "example": "DAY",
1344
+ "enum": [
1345
+ "MINUTE",
1346
+ "HOUR",
1347
+ "DAY",
1348
+ "WEEK",
1349
+ "MONTH",
1350
+ "QUARTER",
1351
+ "YEAR",
1352
+ "MINUTE_OF_HOUR",
1353
+ "HOUR_OF_DAY",
1354
+ "DAY_OF_WEEK",
1355
+ "DAY_OF_MONTH",
1356
+ "DAY_OF_YEAR",
1357
+ "WEEK_OF_YEAR",
1358
+ "MONTH_OF_YEAR",
1359
+ "QUARTER_OF_YEAR"
1360
+ ]
1361
+ },
1362
+ "from": {
1363
+ "type": "integer",
1364
+ "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').",
1365
+ "format": "int32",
1366
+ "example": -6
1367
+ },
1368
+ "to": {
1369
+ "type": "integer",
1370
+ "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, ...).",
1371
+ "format": "int32",
1372
+ "example": 0
1373
+ },
1374
+ "applyOnResult": {
1375
+ "type": "boolean"
1376
+ },
1377
+ "dataset": {
1378
+ "$ref": "#/components/schemas/AfmObjectIdentifierDataset"
1379
+ }
1380
+ }
1381
+ }
1382
+ },
1383
+ "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."
1384
+ },
1385
+ "SimpleMeasureDefinition": {
1386
+ "required": ["measure"],
1387
+ "type": "object",
1388
+ "properties": {
1389
+ "measure": {
1390
+ "required": ["item"],
1391
+ "type": "object",
1392
+ "properties": {
1393
+ "item": {
1394
+ "$ref": "#/components/schemas/AfmObjectIdentifierCore"
1395
+ },
1396
+ "aggregation": {
1397
+ "type": "string",
1398
+ "description": "Definition of aggregation type of the metric.",
1399
+ "example": "SUM",
1400
+ "enum": [
1401
+ "SUM",
1402
+ "COUNT",
1403
+ "AVG",
1404
+ "MIN",
1405
+ "MAX",
1406
+ "MEDIAN",
1407
+ "RUNSUM",
1408
+ "APPROXIMATE_COUNT"
1409
+ ]
1410
+ },
1411
+ "computeRatio": {
1412
+ "type": "boolean",
1413
+ "description": "If true compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).",
1414
+ "example": true,
1415
+ "default": false
1416
+ },
1417
+ "filters": {
1418
+ "type": "array",
1419
+ "description": "Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.",
1420
+ "items": {
1421
+ "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure"
1422
+ }
1423
+ }
1424
+ }
1425
+ }
1426
+ }
1427
+ },
1428
+ "AttributeFormat": {
1429
+ "required": ["locale", "pattern"],
1430
+ "type": "object",
1431
+ "properties": {
1432
+ "locale": {
1433
+ "type": "string",
1434
+ "description": "Format locale"
1435
+ },
1436
+ "pattern": {
1437
+ "type": "string",
1438
+ "description": "Format pattern"
1439
+ }
1440
+ }
1441
+ },
1442
+ "KeyDriversDimension": {
1443
+ "required": ["attribute", "attributeName", "label", "labelName"],
1444
+ "type": "object",
1445
+ "properties": {
1446
+ "label": {
1447
+ "$ref": "#/components/schemas/RestApiIdentifier"
1448
+ },
1449
+ "labelName": {
1450
+ "type": "string"
1451
+ },
1452
+ "attribute": {
1453
+ "$ref": "#/components/schemas/RestApiIdentifier"
1454
+ },
1455
+ "attributeName": {
1456
+ "type": "string"
1457
+ },
1458
+ "granularity": {
1459
+ "type": "string",
1460
+ "enum": [
1461
+ "MINUTE",
1462
+ "HOUR",
1463
+ "DAY",
1464
+ "WEEK",
1465
+ "MONTH",
1466
+ "QUARTER",
1467
+ "YEAR",
1468
+ "MINUTE_OF_HOUR",
1469
+ "HOUR_OF_DAY",
1470
+ "DAY_OF_WEEK",
1471
+ "DAY_OF_MONTH",
1472
+ "DAY_OF_YEAR",
1473
+ "WEEK_OF_YEAR",
1474
+ "MONTH_OF_YEAR",
1475
+ "QUARTER_OF_YEAR"
1476
+ ]
1477
+ },
1478
+ "format": {
1479
+ "$ref": "#/components/schemas/AttributeFormat"
1480
+ },
1481
+ "valueType": {
1482
+ "type": "string",
1483
+ "enum": ["TEXT", "HYPERLINK", "GEO", "GEO_LONGITUDE", "GEO_LATITUDE", "IMAGE"]
1484
+ }
1485
+ }
1486
+ },
1487
+ "KeyDriversResponse": {
1488
+ "required": ["dimensions", "links"],
1489
+ "type": "object",
1490
+ "properties": {
1491
+ "dimensions": {
1492
+ "type": "array",
1493
+ "items": {
1494
+ "$ref": "#/components/schemas/KeyDriversDimension"
1495
+ }
1496
+ },
1497
+ "links": {
1498
+ "$ref": "#/components/schemas/ExecutionLinks"
1499
+ }
1500
+ }
1501
+ },
1502
+ "RestApiIdentifier": {
1503
+ "required": ["id", "type"],
1504
+ "type": "object",
1505
+ "properties": {
1506
+ "id": {
1507
+ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
1508
+ "type": "string",
1509
+ "example": "sample_item.price"
1510
+ },
1511
+ "type": {
1512
+ "type": "string",
1513
+ "example": "fact"
1514
+ }
1515
+ },
1516
+ "description": "Object identifier."
1517
+ },
1518
+ "Element": {
1519
+ "required": ["primaryTitle", "title"],
1520
+ "type": "object",
1521
+ "properties": {
1522
+ "title": {
1523
+ "type": "string",
1524
+ "description": "Title of requested label.",
1525
+ "nullable": true
1526
+ },
1527
+ "primaryTitle": {
1528
+ "type": "string",
1529
+ "description": "Title of primary label of attribute owning requested label, null if the title is null or the primary label is excluded",
1530
+ "nullable": true
1531
+ }
1532
+ },
1533
+ "description": "List of returned elements."
1534
+ },
1535
+ "ElementsResponse": {
1536
+ "required": ["elements", "paging", "primaryLabel"],
1537
+ "type": "object",
1538
+ "properties": {
1539
+ "primaryLabel": {
1540
+ "$ref": "#/components/schemas/RestApiIdentifier"
1541
+ },
1542
+ "elements": {
1543
+ "type": "array",
1544
+ "description": "List of returned elements.",
1545
+ "items": {
1546
+ "$ref": "#/components/schemas/Element"
1547
+ }
1548
+ },
1549
+ "paging": {
1550
+ "$ref": "#/components/schemas/Paging"
1551
+ },
1552
+ "granularity": {
1553
+ "type": "string",
1554
+ "description": "Granularity of requested label in case of date attribute",
1555
+ "enum": [
1556
+ "MINUTE",
1557
+ "HOUR",
1558
+ "DAY",
1559
+ "WEEK",
1560
+ "MONTH",
1561
+ "QUARTER",
1562
+ "YEAR",
1563
+ "MINUTE_OF_HOUR",
1564
+ "HOUR_OF_DAY",
1565
+ "DAY_OF_WEEK",
1566
+ "DAY_OF_MONTH",
1567
+ "DAY_OF_YEAR",
1568
+ "WEEK_OF_YEAR",
1569
+ "MONTH_OF_YEAR",
1570
+ "QUARTER_OF_YEAR"
1571
+ ]
1572
+ },
1573
+ "format": {
1574
+ "$ref": "#/components/schemas/AttributeFormat"
1575
+ },
1576
+ "cacheId": {
1577
+ "type": "string",
1578
+ "description": "The client can use this in subsequent requests (like paging or search) to get results from the same point in time as the previous request. This is useful when the underlying data source has caches disabled and the client wants to avoid seeing inconsistent results and to also avoid excessive queries to the database itself."
1579
+ }
1580
+ },
1581
+ "description": "Entity holding list of sorted & filtered label elements, related primary label of attribute owning requested label and paging."
1582
+ },
1583
+ "Paging": {
1584
+ "required": ["count", "offset", "total"],
1585
+ "type": "object",
1586
+ "properties": {
1587
+ "total": {
1588
+ "type": "integer",
1589
+ "description": "Count of returnable items ignoring paging.",
1590
+ "format": "int32",
1591
+ "example": 100
1592
+ },
1593
+ "count": {
1594
+ "type": "integer",
1595
+ "description": "Count of items in this page.",
1596
+ "format": "int32",
1597
+ "example": 5
1598
+ },
1599
+ "offset": {
1600
+ "type": "integer",
1601
+ "description": "Offset of this page.",
1602
+ "format": "int32",
1603
+ "example": 10
1604
+ },
1605
+ "next": {
1606
+ "type": "string",
1607
+ "description": "Link to next page, or null if this is last page.",
1608
+ "example": "https://sample.gooddata.com/api/v1/actions/workspaces/sampleWorkspace/execution/collectLabelElements?label=sample.price&limit=5&offset=10"
1609
+ }
1610
+ },
1611
+ "description": "Current page description."
1612
+ },
1613
+ "DependsOn": {
1614
+ "required": ["label", "values"],
966
1615
  "type": "object",
967
1616
  "description": "Filter definition type specified by label and values.",
968
1617
  "allOf": [
@@ -1101,59 +1750,6 @@
1101
1750
  },
1102
1751
  "description": "Specifies what is used for filtering."
1103
1752
  },
1104
- "RelativeDateFilter": {
1105
- "required": ["relativeDateFilter"],
1106
- "type": "object",
1107
- "properties": {
1108
- "relativeDateFilter": {
1109
- "required": ["from", "granularity", "to", "dataset"],
1110
- "type": "object",
1111
- "properties": {
1112
- "granularity": {
1113
- "type": "string",
1114
- "description": "Date granularity specifying particular date attribute in given dimension.",
1115
- "example": "DAY",
1116
- "enum": [
1117
- "MINUTE",
1118
- "HOUR",
1119
- "DAY",
1120
- "WEEK",
1121
- "MONTH",
1122
- "QUARTER",
1123
- "YEAR",
1124
- "MINUTE_OF_HOUR",
1125
- "HOUR_OF_DAY",
1126
- "DAY_OF_WEEK",
1127
- "DAY_OF_MONTH",
1128
- "DAY_OF_YEAR",
1129
- "WEEK_OF_YEAR",
1130
- "MONTH_OF_YEAR",
1131
- "QUARTER_OF_YEAR"
1132
- ]
1133
- },
1134
- "from": {
1135
- "type": "integer",
1136
- "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').",
1137
- "format": "int32",
1138
- "example": -6
1139
- },
1140
- "to": {
1141
- "type": "integer",
1142
- "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, ...).",
1143
- "format": "int32",
1144
- "example": 0
1145
- },
1146
- "applyOnResult": {
1147
- "type": "boolean"
1148
- },
1149
- "dataset": {
1150
- "$ref": "#/components/schemas/AfmObjectIdentifierDataset"
1151
- }
1152
- }
1153
- }
1154
- },
1155
- "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."
1156
- },
1157
1753
  "ValidateByItem": {
1158
1754
  "required": ["id", "type"],
1159
1755
  "type": "object",
@@ -1217,196 +1813,22 @@
1217
1813
  {
1218
1814
  "$ref": "#/components/schemas/RankingFilter"
1219
1815
  }
1220
- ]
1221
- },
1222
- "AfmExecution": {
1223
- "required": ["execution", "resultSpec"],
1224
- "type": "object",
1225
- "properties": {
1226
- "execution": {
1227
- "$ref": "#/components/schemas/AFM"
1228
- },
1229
- "resultSpec": {
1230
- "$ref": "#/components/schemas/ResultSpec"
1231
- },
1232
- "settings": {
1233
- "$ref": "#/components/schemas/ExecutionSettings"
1234
- }
1235
- }
1236
- },
1237
- "AfmIdentifier": {
1238
- "type": "object",
1239
- "oneOf": [
1240
- {
1241
- "$ref": "#/components/schemas/AfmObjectIdentifier"
1242
- },
1243
- {
1244
- "$ref": "#/components/schemas/AfmLocalIdentifier"
1245
- }
1246
- ]
1247
- },
1248
- "AfmLocalIdentifier": {
1249
- "required": ["localIdentifier"],
1250
- "type": "object",
1251
- "properties": {
1252
- "localIdentifier": {
1253
- "pattern": "^[.a-zA-Z0-9_-]+$",
1254
- "type": "string",
1255
- "example": "sampleAutoGenerated0123_ID"
1256
- }
1257
- }
1258
- },
1259
- "AfmObjectIdentifier": {
1260
- "required": ["identifier"],
1261
- "type": "object",
1262
- "properties": {
1263
- "identifier": {
1264
- "required": ["type", "id"],
1265
- "type": "object",
1266
- "properties": {
1267
- "type": {
1268
- "type": "string",
1269
- "example": "fact",
1270
- "enum": [
1271
- "analyticalDashboard",
1272
- "attribute",
1273
- "dashboardPlugin",
1274
- "dataset",
1275
- "fact",
1276
- "label",
1277
- "metric",
1278
- "prompt",
1279
- "visualizationObject",
1280
- "filterContext"
1281
- ]
1282
- },
1283
- "id": {
1284
- "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
1285
- "type": "string",
1286
- "example": "sample_item.price"
1287
- }
1288
- }
1289
- }
1290
- },
1291
- "description": "ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers."
1292
- },
1293
- "AfmObjectIdentifierAttribute": {
1294
- "required": ["identifier"],
1295
- "type": "object",
1296
- "properties": {
1297
- "identifier": {
1298
- "required": ["id", "type"],
1299
- "type": "object",
1300
- "properties": {
1301
- "id": {
1302
- "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
1303
- "type": "string",
1304
- "example": "sample_item.price"
1305
- },
1306
- "type": {
1307
- "type": "string",
1308
- "enum": ["attribute"]
1309
- }
1310
- }
1311
- }
1312
- }
1313
- },
1314
- "AfmObjectIdentifierCore": {
1315
- "required": ["identifier"],
1316
- "type": "object",
1317
- "properties": {
1318
- "identifier": {
1319
- "required": ["id", "type"],
1320
- "type": "object",
1321
- "properties": {
1322
- "id": {
1323
- "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
1324
- "type": "string",
1325
- "example": "sample_item.price"
1326
- },
1327
- "type": {
1328
- "type": "string",
1329
- "enum": ["attribute", "label", "fact", "metric"]
1330
- }
1331
- }
1332
- }
1333
- }
1334
- },
1335
- "AfmObjectIdentifierLabel": {
1336
- "required": ["identifier"],
1337
- "type": "object",
1338
- "properties": {
1339
- "identifier": {
1340
- "required": ["type", "id"],
1341
- "type": "object",
1342
- "properties": {
1343
- "type": {
1344
- "type": "string",
1345
- "enum": ["label"]
1346
- },
1347
- "id": {
1348
- "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
1349
- "type": "string",
1350
- "example": "sample_item.price"
1351
- }
1352
- }
1353
- }
1354
- }
1355
- },
1356
- "ArithmeticMeasureDefinition": {
1357
- "required": ["arithmeticMeasure"],
1358
- "type": "object",
1359
- "properties": {
1360
- "arithmeticMeasure": {
1361
- "required": ["measureIdentifiers", "operator"],
1362
- "type": "object",
1363
- "properties": {
1364
- "measureIdentifiers": {
1365
- "type": "array",
1366
- "description": "List of metrics to apply arithmetic operation by chosen operator.",
1367
- "items": {
1368
- "$ref": "#/components/schemas/AfmLocalIdentifier"
1369
- }
1370
- },
1371
- "operator": {
1372
- "type": "string",
1373
- "description": "Arithmetic operator describing operation between metrics.",
1374
- "example": "SUM",
1375
- "enum": ["SUM", "DIFFERENCE", "MULTIPLICATION", "RATIO", "CHANGE"]
1376
- }
1377
- }
1378
- }
1379
- },
1380
- "description": "Metric representing arithmetics between metrics."
1381
- },
1382
- "AttributeFilter": {
1383
- "type": "object",
1384
- "description": "Abstract filter definition type attributes",
1385
- "oneOf": [
1386
- {
1387
- "$ref": "#/components/schemas/NegativeAttributeFilter"
1388
- },
1389
- {
1390
- "$ref": "#/components/schemas/PositiveAttributeFilter"
1391
- }
1392
- ]
1393
- },
1394
- "AttributeFilterElements": {
1395
- "required": ["values"],
1396
- "type": "object",
1397
- "properties": {
1398
- "values": {
1399
- "uniqueItems": true,
1400
- "type": "array",
1401
- "description": "Set of label values.",
1402
- "example": ["value1", "value2"],
1403
- "items": {
1404
- "type": "string",
1405
- "nullable": true
1406
- }
1407
- }
1408
- },
1409
- "description": "Filter on specific set of label values."
1816
+ ]
1817
+ },
1818
+ "AfmExecution": {
1819
+ "required": ["execution", "resultSpec"],
1820
+ "type": "object",
1821
+ "properties": {
1822
+ "execution": {
1823
+ "$ref": "#/components/schemas/AFM"
1824
+ },
1825
+ "resultSpec": {
1826
+ "$ref": "#/components/schemas/ResultSpec"
1827
+ },
1828
+ "settings": {
1829
+ "$ref": "#/components/schemas/ExecutionSettings"
1830
+ }
1831
+ }
1410
1832
  },
1411
1833
  "AttributeItem": {
1412
1834
  "required": ["label", "localIdentifier"],
@@ -1582,18 +2004,6 @@
1582
2004
  }
1583
2005
  ]
1584
2006
  },
1585
- "FilterDefinitionForSimpleMeasure": {
1586
- "type": "object",
1587
- "description": "Abstract filter definition type for simple metric.",
1588
- "oneOf": [
1589
- {
1590
- "$ref": "#/components/schemas/DateFilter"
1591
- },
1592
- {
1593
- "$ref": "#/components/schemas/AttributeFilter"
1594
- }
1595
- ]
1596
- },
1597
2007
  "InlineFilterDefinition": {
1598
2008
  "required": ["inline"],
1599
2009
  "type": "object",
@@ -1613,54 +2023,6 @@
1613
2023
  },
1614
2024
  "description": "Filter in form of direct MAQL query."
1615
2025
  },
1616
- "InlineMeasureDefinition": {
1617
- "required": ["inline"],
1618
- "type": "object",
1619
- "properties": {
1620
- "inline": {
1621
- "required": ["maql"],
1622
- "type": "object",
1623
- "properties": {
1624
- "maql": {
1625
- "type": "string"
1626
- }
1627
- }
1628
- }
1629
- },
1630
- "description": "Metric defined by the raw MAQL query."
1631
- },
1632
- "MeasureDefinition": {
1633
- "type": "object",
1634
- "description": "Abstract metric definition type",
1635
- "oneOf": [
1636
- {
1637
- "$ref": "#/components/schemas/InlineMeasureDefinition"
1638
- },
1639
- {
1640
- "$ref": "#/components/schemas/ArithmeticMeasureDefinition"
1641
- },
1642
- {
1643
- "$ref": "#/components/schemas/SimpleMeasureDefinition"
1644
- },
1645
- {
1646
- "$ref": "#/components/schemas/PopMeasureDefinition"
1647
- }
1648
- ]
1649
- },
1650
- "MeasureItem": {
1651
- "required": ["definition", "localIdentifier"],
1652
- "type": "object",
1653
- "properties": {
1654
- "localIdentifier": {
1655
- "pattern": "^[.a-zA-Z0-9_-]+$",
1656
- "type": "string",
1657
- "example": "metric_1"
1658
- },
1659
- "definition": {
1660
- "$ref": "#/components/schemas/MeasureDefinition"
1661
- }
1662
- }
1663
- },
1664
2026
  "MeasureValueFilter": {
1665
2027
  "type": "object",
1666
2028
  "description": "Abstract filter definition type filtering by the value of the metric.",
@@ -1673,131 +2035,6 @@
1673
2035
  }
1674
2036
  ]
1675
2037
  },
1676
- "NegativeAttributeFilter": {
1677
- "required": ["negativeAttributeFilter"],
1678
- "type": "object",
1679
- "properties": {
1680
- "negativeAttributeFilter": {
1681
- "required": ["notIn", "label"],
1682
- "type": "object",
1683
- "properties": {
1684
- "notIn": {
1685
- "$ref": "#/components/schemas/AttributeFilterElements"
1686
- },
1687
- "applyOnResult": {
1688
- "type": "boolean"
1689
- },
1690
- "label": {
1691
- "$ref": "#/components/schemas/AfmIdentifier"
1692
- }
1693
- }
1694
- }
1695
- },
1696
- "description": "Filter able to limit element values by label and related selected negated elements."
1697
- },
1698
- "PopDataset": {
1699
- "required": ["dataset", "periodsAgo"],
1700
- "type": "object",
1701
- "properties": {
1702
- "dataset": {
1703
- "$ref": "#/components/schemas/AfmObjectIdentifierDataset"
1704
- },
1705
- "periodsAgo": {
1706
- "type": "integer",
1707
- "format": "int32"
1708
- }
1709
- }
1710
- },
1711
- "PopDatasetMeasureDefinition": {
1712
- "required": ["previousPeriodMeasure"],
1713
- "type": "object",
1714
- "properties": {
1715
- "previousPeriodMeasure": {
1716
- "required": ["dateDatasets", "measureIdentifier"],
1717
- "type": "object",
1718
- "properties": {
1719
- "measureIdentifier": {
1720
- "$ref": "#/components/schemas/AfmLocalIdentifier"
1721
- },
1722
- "dateDatasets": {
1723
- "type": "array",
1724
- "items": {
1725
- "$ref": "#/components/schemas/PopDataset"
1726
- }
1727
- }
1728
- }
1729
- }
1730
- },
1731
- "description": "Previous period type of metric."
1732
- },
1733
- "PopDate": {
1734
- "required": ["attribute", "periodsAgo"],
1735
- "type": "object",
1736
- "properties": {
1737
- "attribute": {
1738
- "$ref": "#/components/schemas/AfmObjectIdentifierAttribute"
1739
- },
1740
- "periodsAgo": {
1741
- "type": "integer",
1742
- "format": "int32"
1743
- }
1744
- }
1745
- },
1746
- "PopDateMeasureDefinition": {
1747
- "required": ["overPeriodMeasure"],
1748
- "type": "object",
1749
- "properties": {
1750
- "overPeriodMeasure": {
1751
- "required": ["dateAttributes", "measureIdentifier"],
1752
- "type": "object",
1753
- "properties": {
1754
- "measureIdentifier": {
1755
- "$ref": "#/components/schemas/AfmLocalIdentifier"
1756
- },
1757
- "dateAttributes": {
1758
- "type": "array",
1759
- "items": {
1760
- "$ref": "#/components/schemas/PopDate"
1761
- }
1762
- }
1763
- }
1764
- }
1765
- },
1766
- "description": "Period over period type of metric."
1767
- },
1768
- "PopMeasureDefinition": {
1769
- "type": "object",
1770
- "oneOf": [
1771
- {
1772
- "$ref": "#/components/schemas/PopDatasetMeasureDefinition"
1773
- },
1774
- {
1775
- "$ref": "#/components/schemas/PopDateMeasureDefinition"
1776
- }
1777
- ]
1778
- },
1779
- "PositiveAttributeFilter": {
1780
- "required": ["positiveAttributeFilter"],
1781
- "type": "object",
1782
- "properties": {
1783
- "positiveAttributeFilter": {
1784
- "required": ["in", "label"],
1785
- "type": "object",
1786
- "properties": {
1787
- "in": {
1788
- "$ref": "#/components/schemas/AttributeFilterElements"
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 elements."
1800
- },
1801
2038
  "RangeMeasureValueFilter": {
1802
2039
  "required": ["rangeMeasureValueFilter"],
1803
2040
  "type": "object",
@@ -1884,49 +2121,6 @@
1884
2121
  },
1885
2122
  "description": "Specifies how the result data will be formatted (```dimensions```) and which additional data shall be computed (```totals```)."
1886
2123
  },
1887
- "SimpleMeasureDefinition": {
1888
- "required": ["measure"],
1889
- "type": "object",
1890
- "properties": {
1891
- "measure": {
1892
- "required": ["item"],
1893
- "type": "object",
1894
- "properties": {
1895
- "item": {
1896
- "$ref": "#/components/schemas/AfmObjectIdentifierCore"
1897
- },
1898
- "aggregation": {
1899
- "type": "string",
1900
- "description": "Definition of aggregation type of the metric.",
1901
- "example": "SUM",
1902
- "enum": [
1903
- "SUM",
1904
- "COUNT",
1905
- "AVG",
1906
- "MIN",
1907
- "MAX",
1908
- "MEDIAN",
1909
- "RUNSUM",
1910
- "APPROXIMATE_COUNT"
1911
- ]
1912
- },
1913
- "computeRatio": {
1914
- "type": "boolean",
1915
- "description": "If true compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).",
1916
- "example": true,
1917
- "default": false
1918
- },
1919
- "filters": {
1920
- "type": "array",
1921
- "description": "Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.",
1922
- "items": {
1923
- "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure"
1924
- }
1925
- }
1926
- }
1927
- }
1928
- }
1929
- },
1930
2124
  "SortKey": {
1931
2125
  "type": "object",
1932
2126
  "oneOf": [
@@ -2345,13 +2539,13 @@
2345
2539
  "nullable": true
2346
2540
  }
2347
2541
  },
2348
- "ycoord": {
2542
+ "xcoord": {
2349
2543
  "type": "array",
2350
2544
  "items": {
2351
2545
  "type": "number"
2352
2546
  }
2353
2547
  },
2354
- "xcoord": {
2548
+ "ycoord": {
2355
2549
  "type": "array",
2356
2550
  "items": {
2357
2551
  "type": "number"
@@ -2359,6 +2553,15 @@
2359
2553
  }
2360
2554
  }
2361
2555
  },
2556
+ "KeyDriversResult": {
2557
+ "required": ["data"],
2558
+ "type": "object",
2559
+ "properties": {
2560
+ "data": {
2561
+ "type": "object"
2562
+ }
2563
+ }
2564
+ },
2362
2565
  "ResultCacheMetadata": {
2363
2566
  "required": ["afm", "executionResponse", "resultSize", "resultSpec"],
2364
2567
  "type": "object",