@astrato-io/visualizations 0.0.0-stage → 0.6.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 (145) hide show
  1. package/CHANGELOG.md +23 -0
  2. package/LICENSE +93 -0
  3. package/README.md +843 -2
  4. package/THIRD_PARTY_NOTICES.md +8387 -0
  5. package/VISUALIZATION_DEFINITIONS.md +2378 -0
  6. package/chunks/LinearProgress-CUZ0D8_t.js +253 -0
  7. package/chunks/Radio-Ciu-F4CU.js +957 -0
  8. package/chunks/ToggleButton-BCJc3Jlc.js +153 -0
  9. package/chunks/_baseFlatten-DPXPOrea.js +7076 -0
  10. package/chunks/accessors-DemrDevR.js +128 -0
  11. package/chunks/app-filter-bar.compiler-j_CVoWTa.js +55 -0
  12. package/chunks/bar.compiler-oqaPzIut.js +370 -0
  13. package/chunks/color-settings-ZIvgNTq1.js +10 -0
  14. package/chunks/coloring-C16AUZEi.js +663 -0
  15. package/chunks/data-item-resolution-1lvYB5ln.js +53 -0
  16. package/chunks/debounce-fn-CUixuz45.js +7 -0
  17. package/chunks/escobar-BGqT1EsE.js +34580 -0
  18. package/chunks/event-bus-KiSiCJrC.js +2683 -0
  19. package/chunks/events-WZut5Ow6.js +4 -0
  20. package/chunks/extend-BKUkc4_i.js +37 -0
  21. package/chunks/filter.compiler-CuLtc_02.js +60 -0
  22. package/chunks/filtering-Yq4DEa0t.js +953 -0
  23. package/chunks/gauge-target-type-BkKXAqkX.js +4 -0
  24. package/chunks/grouping-type-BX_9Ix5q.js +3 -0
  25. package/chunks/interfaces-VUY4_yVO.js +8742 -0
  26. package/chunks/line-settings-DfYTUyPz.js +4 -0
  27. package/chunks/line.compiler-BpA_6Tc7.js +188 -0
  28. package/chunks/metadata-CPXdYoln.js +28 -0
  29. package/chunks/number.compiler-DbkWcG4S.js +44 -0
  30. package/chunks/pie-uv42Eqal.js +10 -0
  31. package/chunks/range-DrzdfBX4.js +22 -0
  32. package/chunks/registry-CExpGJ1N.js +920 -0
  33. package/chunks/requirements-DNhuShLS.js +6 -0
  34. package/chunks/rolldown-runtime-DleVn1XH.js +28 -0
  35. package/chunks/set-coloring-datafield-B3uIS1Pe.js +8 -0
  36. package/chunks/shared-CKDL4hx9.js +1171 -0
  37. package/chunks/src-BC7cGcJ-.js +2024 -0
  38. package/chunks/src-BOS6SqkZ.js +67 -0
  39. package/chunks/src-C0LgoUWY.js +26105 -0
  40. package/chunks/src-Cum_2NLV.js +12145 -0
  41. package/chunks/src-D9XogOrc.js +422 -0
  42. package/chunks/src-Dun_jXtz.js +10295 -0
  43. package/chunks/src-DvX5LU9T.js +14742 -0
  44. package/chunks/standalone-87YV_m9n.js +687 -0
  45. package/chunks/standalone-BDCwI6Hn.js +4619 -0
  46. package/chunks/standalone-BH5NqDwp.js +1763 -0
  47. package/chunks/standalone-BLVAWLNJ.js +385 -0
  48. package/chunks/standalone-BPomtAVs.js +2 -0
  49. package/chunks/standalone-BXyBcUOQ.js +2 -0
  50. package/chunks/standalone-BYm1UjLr.js +140 -0
  51. package/chunks/standalone-BllF4rDp.js +383 -0
  52. package/chunks/standalone-BmfMt74U.js +726 -0
  53. package/chunks/standalone-BqWyrnZI.js +281 -0
  54. package/chunks/standalone-C85u7U6I.js +340 -0
  55. package/chunks/standalone-CCNtaJ7s.js +741 -0
  56. package/chunks/standalone-CDQnr6qT.js +345 -0
  57. package/chunks/standalone-CNyNHKVx.js +674 -0
  58. package/chunks/standalone-CY57qwZ-.js +1129 -0
  59. package/chunks/standalone-CZynjFG7.js +12979 -0
  60. package/chunks/standalone-D5vnf-9y.js +3943 -0
  61. package/chunks/standalone-DFPva_ku.js +299 -0
  62. package/chunks/standalone-DQxxNwF8.js +675 -0
  63. package/chunks/standalone-DS9T0FZ-.js +830 -0
  64. package/chunks/standalone-Dx3MLlrO.js +512 -0
  65. package/chunks/standalone-DzixzZAL.js +411 -0
  66. package/chunks/standalone-QJ1kKMnO.js +6 -0
  67. package/chunks/standalone-jiz0L2Dg.js +3855 -0
  68. package/chunks/standalone-lBm9hQ-q.js +179 -0
  69. package/chunks/standalone-rJ45Zfl1.js +68 -0
  70. package/chunks/stroke-dash-UgMEcCS4.js +6 -0
  71. package/chunks/table.compiler-BrXkm4Fz.js +213 -0
  72. package/chunks/toInteger-DVZr-D1j.js +11 -0
  73. package/chunks/treemap-x_zmJoG7.js +23 -0
  74. package/chunks/typeof-CJDtcySz.js +13 -0
  75. package/chunks/types-dVVCsDWD.js +4 -0
  76. package/chunks/ui-D1HQNIBy.js +54039 -0
  77. package/chunks/url-utils-B17gj_mr.js +5501 -0
  78. package/chunks/useFieldName-oqQ3bvnO.js +7 -0
  79. package/chunks/utils-Ba9T0TqC.js +31097 -0
  80. package/chunks/view-CLqWMV7Z.js +156 -0
  81. package/definitions.js +3 -0
  82. package/docs/operations/astrato-app-filter-bar.md +161 -0
  83. package/docs/operations/bar.md +7050 -0
  84. package/docs/operations/combo.md +5825 -0
  85. package/docs/operations/date-picker.md +644 -0
  86. package/docs/operations/distribution-gauge.md +3218 -0
  87. package/docs/operations/dot.md +5662 -0
  88. package/docs/operations/filter.md +1507 -0
  89. package/docs/operations/gauge.md +3452 -0
  90. package/docs/operations/heatMap.md +6026 -0
  91. package/docs/operations/histogram.md +1870 -0
  92. package/docs/operations/iframe.md +56 -0
  93. package/docs/operations/image.md +177 -0
  94. package/docs/operations/index.md +46 -0
  95. package/docs/operations/line.md +6468 -0
  96. package/docs/operations/number.md +3969 -0
  97. package/docs/operations/pie.md +6089 -0
  98. package/docs/operations/radar.md +4646 -0
  99. package/docs/operations/sankey.md +3210 -0
  100. package/docs/operations/scatter.md +6075 -0
  101. package/docs/operations/shape.md +315 -0
  102. package/docs/operations/simpleTextObject.md +706 -0
  103. package/docs/operations/slider.md +230 -0
  104. package/docs/operations/table.md +8790 -0
  105. package/docs/operations/tree.md +2874 -0
  106. package/docs/operations/treemap.md +3619 -0
  107. package/docs/operations/waterfall.md +2938 -0
  108. package/docs/operations/word-cloud.md +3071 -0
  109. package/getters.js +18 -0
  110. package/index.js +1183 -0
  111. package/metadata.js +20 -0
  112. package/operations.js +64 -0
  113. package/package.json +191 -4
  114. package/src/definitions/index.d.ts +2 -0
  115. package/src/definitions/shared/index.d.ts +5 -0
  116. package/src/definitions/shared/lib/available-fields.d.ts +36 -0
  117. package/src/definitions/shared/lib/compilers/index.d.ts +7 -0
  118. package/src/definitions/shared/lib/registry/compile.d.ts +2 -0
  119. package/src/definitions/shared/lib/registry/descriptor-registry.d.ts +587 -0
  120. package/src/definitions/shared/lib/registry/index.d.ts +3 -0
  121. package/src/definitions/shared/lib/registry/validation.d.ts +3 -0
  122. package/src/definitions/shared/lib/schemas/app-filter-bar.schema.d.ts +22 -0
  123. package/src/definitions/shared/lib/schemas/bar.schema.d.ts +73 -0
  124. package/src/definitions/shared/lib/schemas/broad-chart.schema.d.ts +68 -0
  125. package/src/definitions/shared/lib/schemas/common.schema.d.ts +304 -0
  126. package/src/definitions/shared/lib/schemas/filter.schema.d.ts +22 -0
  127. package/src/definitions/shared/lib/schemas/index.d.ts +9 -0
  128. package/src/definitions/shared/lib/schemas/line.schema.d.ts +72 -0
  129. package/src/definitions/shared/lib/schemas/number.schema.d.ts +21 -0
  130. package/src/definitions/shared/lib/schemas/object.schema.d.ts +215 -0
  131. package/src/definitions/shared/lib/schemas/table.schema.d.ts +458 -0
  132. package/src/definitions/shared/lib/types/compilation.types.d.ts +36 -0
  133. package/src/definitions/shared/lib/types/definition.types.d.ts +2 -0
  134. package/src/definitions/shared/lib/types/descriptor.types.d.ts +39 -0
  135. package/src/definitions/shared/lib/types/index.d.ts +3 -0
  136. package/src/getters/index.d.ts +30 -0
  137. package/src/index.d.ts +4 -0
  138. package/src/metadata/index.d.ts +4 -0
  139. package/src/operations/index.d.ts +30 -0
  140. package/src/registry/index.d.ts +6 -0
  141. package/src/runtime/index.d.ts +2 -0
  142. package/src/types.d.ts +307 -0
  143. package/src/visualization-catalog.d.ts +82 -0
  144. package/src/web-components/index.d.ts +12 -0
  145. package/styles.css +2 -0
@@ -0,0 +1,3969 @@
1
+ <!-- Generated from operation manifests. Do not edit this file manually. -->
2
+
3
+ # `number` operations
4
+
5
+ Reference for `@astrato-io/visualizations@0.6.4`.
6
+
7
+ [All visualization types](./index.md)
8
+
9
+ Use each schema below for the request’s `payload`, not for the whole operation request. Names and payloads are specific to this visualization type. An operation can still require particular fields or chart state; see its description.
10
+
11
+ ## Available operations
12
+
13
+ - [`addMeasure`](#addmeasure)
14
+ - [`addMeasureAdvancedAdditionalDimensionDataField`](#addmeasureadvancedadditionaldimensiondatafield)
15
+ - [`addMeasureAdvancedDimensionDataField`](#addmeasureadvanceddimensiondatafield)
16
+ - [`addMeasureFilter`](#addmeasurefilter)
17
+ - [`addResultFilter`](#addresultfilter)
18
+ - [`changeMeasureAggregation`](#changemeasureaggregation)
19
+ - [`clearMeasureFilter`](#clearmeasurefilter)
20
+ - [`clearResultFilter`](#clearresultfilter)
21
+ - [`duplicateMeasure`](#duplicatemeasure)
22
+ - [`enableCustomNullValue`](#enablecustomnullvalue)
23
+ - [`enableQueryTimeout`](#enablequerytimeout)
24
+ - [`removeMeasure`](#removemeasure)
25
+ - [`removeMeasureAdvancedAdditionalDimensionDataField`](#removemeasureadvancedadditionaldimensiondatafield)
26
+ - [`removeMeasureAdvancedCompareMeasure`](#removemeasureadvancedcomparemeasure)
27
+ - [`removeMeasureAdvancedDimensionDataField`](#removemeasureadvanceddimensiondatafield)
28
+ - [`setComparisonFontColor`](#setcomparisonfontcolor)
29
+ - [`setComparisonFontFamily`](#setcomparisonfontfamily)
30
+ - [`setComparisonFontStyle`](#setcomparisonfontstyle)
31
+ - [`setComparisonFontWeight`](#setcomparisonfontweight)
32
+ - [`setComparisonGap`](#setcomparisongap)
33
+ - [`setComparisonPosition`](#setcomparisonposition)
34
+ - [`setComparisonRelativeFontSizePercentage`](#setcomparisonrelativefontsizepercentage)
35
+ - [`setCustomNullValue`](#setcustomnullvalue)
36
+ - [`setHorizontalAlign`](#sethorizontalalign)
37
+ - [`setIconPosition`](#seticonposition)
38
+ - [`setMeasureAdvancedAdditionalAggregation`](#setmeasureadvancedadditionalaggregation)
39
+ - [`setMeasureAdvancedAggregation`](#setmeasureadvancedaggregation)
40
+ - [`setMeasureAdvancedCalculationType`](#setmeasureadvancedcalculationtype)
41
+ - [`setMeasureAdvancedCompareMeasure`](#setmeasureadvancedcomparemeasure)
42
+ - [`setMeasureAdvancedComparisonType`](#setmeasureadvancedcomparisontype)
43
+ - [`setMeasureAdvancedDense`](#setmeasureadvanceddense)
44
+ - [`setMeasureAdvancedDimensionsIds`](#setmeasureadvanceddimensionsids)
45
+ - [`setMeasureAdvancedGroupType`](#setmeasureadvancedgrouptype)
46
+ - [`setMeasureAdvancedNonTimePeriod`](#setmeasureadvancednontimeperiod)
47
+ - [`setMeasureAdvancedNonTimePeriodGranularity`](#setmeasureadvancednontimeperiodgranularity)
48
+ - [`setMeasureAdvancedNullIfNotEnoughValues`](#setmeasureadvancednullifnotenoughvalues)
49
+ - [`setMeasureAdvancedOffset`](#setmeasureadvancedoffset)
50
+ - [`setMeasureAdvancedParameter`](#setmeasureadvancedparameter)
51
+ - [`setMeasureAdvancedPercentileApprox`](#setmeasureadvancedpercentileapprox)
52
+ - [`setMeasureAdvancedPercentileContinuous`](#setmeasureadvancedpercentilecontinuous)
53
+ - [`setMeasureAdvancedPercentileValue`](#setmeasureadvancedpercentilevalue)
54
+ - [`setMeasureAdvancedPeriodsPerYear`](#setmeasureadvancedperiodsperyear)
55
+ - [`setMeasureAdvancedRangesComparisonEnabled`](#setmeasureadvancedrangescomparisonenabled)
56
+ - [`setMeasureAdvancedRangesComparisonFirstRangeEnd`](#setmeasureadvancedrangescomparisonfirstrangeend)
57
+ - [`setMeasureAdvancedRangesComparisonFirstRangeStart`](#setmeasureadvancedrangescomparisonfirstrangestart)
58
+ - [`setMeasureAdvancedRangesComparisonSecondRangeEnd`](#setmeasureadvancedrangescomparisonsecondrangeend)
59
+ - [`setMeasureAdvancedRangesComparisonSecondRangeStart`](#setmeasureadvancedrangescomparisonsecondrangestart)
60
+ - [`setMeasureAdvancedRangesComparisonType`](#setmeasureadvancedrangescomparisontype)
61
+ - [`setMeasureAdvancedRankSortDirection`](#setmeasureadvancedranksortdirection)
62
+ - [`setMeasureAdvancedSortingOrder`](#setmeasureadvancedsortingorder)
63
+ - [`setMeasureAdvancedStandardDeviations`](#setmeasureadvancedstandarddeviations)
64
+ - [`setMeasureAdvancedWindowBegin`](#setmeasureadvancedwindowbegin)
65
+ - [`setMeasureAdvancedWindowEnd`](#setmeasureadvancedwindowend)
66
+ - [`setMeasureCurrency`](#setmeasurecurrency)
67
+ - [`setMeasureCurrencyIsPrefix`](#setmeasurecurrencyisprefix)
68
+ - [`setMeasureDefinedParameter`](#setmeasuredefinedparameter)
69
+ - [`setMeasureFilter`](#setmeasurefilter)
70
+ - [`setMeasureFormatString`](#setmeasureformatstring)
71
+ - [`setMeasureFormatType`](#setmeasureformattype)
72
+ - [`setMeasureNegativeType`](#setmeasurenegativetype)
73
+ - [`setNumberFontColor`](#setnumberfontcolor)
74
+ - [`setNumberFontFamily`](#setnumberfontfamily)
75
+ - [`setNumberFontSize`](#setnumberfontsize)
76
+ - [`setNumberFontStyle`](#setnumberfontstyle)
77
+ - [`setNumberFontWeight`](#setnumberfontweight)
78
+ - [`setQueryTimeout`](#setquerytimeout)
79
+ - [`setResultFilter`](#setresultfilter)
80
+ - [`setStaticFilterGroup`](#setstaticfiltergroup)
81
+ - [`setVerticalAlign`](#setverticalalign)
82
+ - [`toggleMeasure`](#togglemeasure)
83
+ - [`toggleMeasureByName`](#togglemeasurebyname)
84
+ - [`updateMeasure`](#updatemeasure)
85
+
86
+ ## `addMeasure`
87
+
88
+ Add measure
89
+
90
+ Add a new measure to the chart
91
+
92
+ **Payload schema**
93
+
94
+ ```json
95
+ {
96
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
97
+ "title": "Add measure schema",
98
+ "anyOf": [
99
+ {
100
+ "type": "object",
101
+ "properties": {
102
+ "sourceKind": {
103
+ "description": "Raw database field from available data `fields`.",
104
+ "type": "string",
105
+ "const": "field"
106
+ },
107
+ "key": {
108
+ "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"",
109
+ "type": "string"
110
+ },
111
+ "aggregation": {
112
+ "description": "Required for raw database fields. Use one of the aggregation names returned for that field.",
113
+ "type": "string"
114
+ },
115
+ "role": {
116
+ "type": "string",
117
+ "enum": ["number-measure", "number-comparison"]
118
+ }
119
+ },
120
+ "required": ["sourceKind", "key", "aggregation", "role"],
121
+ "additionalProperties": false
122
+ },
123
+ {
124
+ "type": "object",
125
+ "properties": {
126
+ "sourceKind": {
127
+ "description": "Predefined/user-defined measure from available data `measures`.",
128
+ "type": "string",
129
+ "const": "measure"
130
+ },
131
+ "key": {
132
+ "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"",
133
+ "type": "string"
134
+ },
135
+ "role": {
136
+ "type": "string",
137
+ "enum": ["number-measure", "number-comparison"]
138
+ }
139
+ },
140
+ "required": ["sourceKind", "key", "role"],
141
+ "additionalProperties": false
142
+ },
143
+ {
144
+ "type": "object",
145
+ "properties": {
146
+ "sourceKind": {
147
+ "description": "Predefined calculation from available data `measures`.",
148
+ "type": "string",
149
+ "const": "calculation"
150
+ },
151
+ "key": {
152
+ "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"",
153
+ "type": "string"
154
+ },
155
+ "role": {
156
+ "type": "string",
157
+ "enum": ["number-measure", "number-comparison"]
158
+ }
159
+ },
160
+ "required": ["sourceKind", "key", "role"],
161
+ "additionalProperties": false
162
+ }
163
+ ]
164
+ }
165
+ ```
166
+
167
+ ## `addMeasureAdvancedAdditionalDimensionDataField`
168
+
169
+ Add advanced bottom dimension
170
+
171
+ Add bottom dimension field for nested ratio advanced calculation
172
+
173
+ **Payload schema**
174
+
175
+ ```json
176
+ {
177
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
178
+ "title": "Add measure advanced additional dimension field schema",
179
+ "type": "object",
180
+ "properties": {
181
+ "dataItemInternalKey": {
182
+ "description": "Internal key of the data item of the measure to be updated",
183
+ "type": "string"
184
+ },
185
+ "dataItemUniqueSignature": {
186
+ "description": "Unique signature of the data item of the measure to be updated",
187
+ "type": "string"
188
+ },
189
+ "collectionKey": {
190
+ "description": "Measure collection key",
191
+ "type": "string",
192
+ "enum": ["measures", "supportingMeasures"]
193
+ },
194
+ "advancedOperationKey": {
195
+ "description": "Advanced operation key",
196
+ "type": "string",
197
+ "enum": ["advancedCalculation", "nestedCalculation"]
198
+ },
199
+ "key": {
200
+ "description": "Engine key of the bottom dimension field to be added",
201
+ "type": "string"
202
+ }
203
+ },
204
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "key"],
205
+ "additionalProperties": false
206
+ }
207
+ ```
208
+
209
+ ## `addMeasureAdvancedDimensionDataField`
210
+
211
+ Add advanced additional dimension
212
+
213
+ Add additional dimension field for nested advanced calculations
214
+
215
+ **Payload schema**
216
+
217
+ ```json
218
+ {
219
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
220
+ "title": "Add measure advanced dimension field schema",
221
+ "type": "object",
222
+ "properties": {
223
+ "dataItemInternalKey": {
224
+ "description": "Internal key of the data item of the measure to be updated",
225
+ "type": "string"
226
+ },
227
+ "dataItemUniqueSignature": {
228
+ "description": "Unique signature of the data item of the measure to be updated",
229
+ "type": "string"
230
+ },
231
+ "collectionKey": {
232
+ "description": "Measure collection key",
233
+ "type": "string",
234
+ "enum": ["measures", "supportingMeasures"]
235
+ },
236
+ "advancedOperationKey": {
237
+ "description": "Advanced operation key",
238
+ "type": "string",
239
+ "enum": ["advancedCalculation", "nestedCalculation"]
240
+ },
241
+ "key": {
242
+ "description": "Engine key of the dimension field to be added",
243
+ "type": "string"
244
+ }
245
+ },
246
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "key"],
247
+ "additionalProperties": false
248
+ }
249
+ ```
250
+
251
+ ## `addMeasureFilter`
252
+
253
+ Add measure filter
254
+
255
+ Add another measure filter before aggregation. Keeps existing filters.
256
+
257
+ **Payload schema**
258
+
259
+ ```json
260
+ {
261
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
262
+ "description": "Add another measure filter before aggregation. Keeps existing filters.",
263
+ "title": "Add measure filter schema",
264
+ "anyOf": [
265
+ {
266
+ "type": "object",
267
+ "properties": {
268
+ "measureName": {
269
+ "description": "Visible measure name or label",
270
+ "type": "string"
271
+ },
272
+ "fieldKey": {
273
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
274
+ "type": "string"
275
+ },
276
+ "operator": {
277
+ "description": "Filter operator that requires a value",
278
+ "type": "string",
279
+ "enum": [
280
+ "equals",
281
+ "doesNotEqual",
282
+ "greaterThan",
283
+ "lessThan",
284
+ "greaterThanOrEqualTo",
285
+ "lessThanOrEqualTo",
286
+ "contains",
287
+ "excludes",
288
+ "like",
289
+ "notLike",
290
+ "startsWith",
291
+ "endsWith"
292
+ ]
293
+ },
294
+ "value": {
295
+ "description": "Filter value",
296
+ "anyOf": [
297
+ {
298
+ "type": "string"
299
+ },
300
+ {
301
+ "type": "object",
302
+ "properties": {
303
+ "type": {
304
+ "type": "string",
305
+ "const": "variable"
306
+ },
307
+ "variableName": {
308
+ "type": "string"
309
+ }
310
+ },
311
+ "required": ["type", "variableName"],
312
+ "additionalProperties": false
313
+ }
314
+ ]
315
+ }
316
+ },
317
+ "required": ["measureName", "fieldKey", "operator", "value"],
318
+ "additionalProperties": false
319
+ },
320
+ {
321
+ "type": "object",
322
+ "properties": {
323
+ "measureName": {
324
+ "description": "Visible measure name or label",
325
+ "type": "string"
326
+ },
327
+ "fieldKey": {
328
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
329
+ "type": "string"
330
+ },
331
+ "operator": {
332
+ "description": "Filter operator that requires valueFrom and valueTo",
333
+ "type": "string",
334
+ "enum": ["isBetween", "isNotBetween"]
335
+ },
336
+ "valueFrom": {
337
+ "description": "Lower filter value",
338
+ "anyOf": [
339
+ {
340
+ "type": "string"
341
+ },
342
+ {
343
+ "type": "object",
344
+ "properties": {
345
+ "type": {
346
+ "type": "string",
347
+ "const": "variable"
348
+ },
349
+ "variableName": {
350
+ "type": "string"
351
+ }
352
+ },
353
+ "required": ["type", "variableName"],
354
+ "additionalProperties": false
355
+ }
356
+ ]
357
+ },
358
+ "valueTo": {
359
+ "description": "Upper filter value",
360
+ "anyOf": [
361
+ {
362
+ "type": "string"
363
+ },
364
+ {
365
+ "type": "object",
366
+ "properties": {
367
+ "type": {
368
+ "type": "string",
369
+ "const": "variable"
370
+ },
371
+ "variableName": {
372
+ "type": "string"
373
+ }
374
+ },
375
+ "required": ["type", "variableName"],
376
+ "additionalProperties": false
377
+ }
378
+ ]
379
+ }
380
+ },
381
+ "required": ["measureName", "fieldKey", "operator", "valueFrom", "valueTo"],
382
+ "additionalProperties": false
383
+ },
384
+ {
385
+ "type": "object",
386
+ "properties": {
387
+ "measureName": {
388
+ "description": "Visible measure name or label",
389
+ "type": "string"
390
+ },
391
+ "fieldKey": {
392
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
393
+ "type": "string"
394
+ },
395
+ "operator": {
396
+ "description": "Filter operator that requires a list of values",
397
+ "type": "string",
398
+ "enum": ["inList", "excludedFromList"]
399
+ },
400
+ "values": {
401
+ "description": "Filter values",
402
+ "minItems": 1,
403
+ "type": "array",
404
+ "items": {
405
+ "type": "string"
406
+ }
407
+ }
408
+ },
409
+ "required": ["measureName", "fieldKey", "operator", "values"],
410
+ "additionalProperties": false
411
+ },
412
+ {
413
+ "type": "object",
414
+ "properties": {
415
+ "measureName": {
416
+ "description": "Visible measure name or label",
417
+ "type": "string"
418
+ },
419
+ "fieldKey": {
420
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
421
+ "type": "string"
422
+ },
423
+ "operator": {
424
+ "description": "Filter operator that does not require values",
425
+ "type": "string",
426
+ "enum": ["isNull", "notNull"]
427
+ }
428
+ },
429
+ "required": ["measureName", "fieldKey", "operator"],
430
+ "additionalProperties": false
431
+ }
432
+ ]
433
+ }
434
+ ```
435
+
436
+ ## `addResultFilter`
437
+
438
+ Add result filter
439
+
440
+ Add another result filter after aggregation. Keeps existing result filters.
441
+
442
+ **Payload schema**
443
+
444
+ ```json
445
+ {
446
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
447
+ "description": "Add another result filter after aggregation. Keeps existing result filters.",
448
+ "title": "Add result filter schema",
449
+ "anyOf": [
450
+ {
451
+ "type": "object",
452
+ "properties": {
453
+ "measureName": {
454
+ "description": "Visible measure name or label",
455
+ "type": "string"
456
+ },
457
+ "operator": {
458
+ "description": "Filter operator that requires a value",
459
+ "type": "string",
460
+ "enum": [
461
+ "equals",
462
+ "doesNotEqual",
463
+ "greaterThan",
464
+ "lessThan",
465
+ "greaterThanOrEqualTo",
466
+ "lessThanOrEqualTo",
467
+ "contains",
468
+ "excludes",
469
+ "like",
470
+ "notLike",
471
+ "startsWith",
472
+ "endsWith"
473
+ ]
474
+ },
475
+ "value": {
476
+ "description": "Filter value",
477
+ "anyOf": [
478
+ {
479
+ "type": "string"
480
+ },
481
+ {
482
+ "type": "object",
483
+ "properties": {
484
+ "type": {
485
+ "type": "string",
486
+ "const": "variable"
487
+ },
488
+ "variableName": {
489
+ "type": "string"
490
+ }
491
+ },
492
+ "required": ["type", "variableName"],
493
+ "additionalProperties": false
494
+ }
495
+ ]
496
+ }
497
+ },
498
+ "required": ["measureName", "operator", "value"],
499
+ "additionalProperties": false
500
+ },
501
+ {
502
+ "type": "object",
503
+ "properties": {
504
+ "measureName": {
505
+ "description": "Visible measure name or label",
506
+ "type": "string"
507
+ },
508
+ "operator": {
509
+ "description": "Filter operator that requires valueFrom and valueTo",
510
+ "type": "string",
511
+ "enum": ["isBetween", "isNotBetween"]
512
+ },
513
+ "valueFrom": {
514
+ "description": "Lower filter value",
515
+ "anyOf": [
516
+ {
517
+ "type": "string"
518
+ },
519
+ {
520
+ "type": "object",
521
+ "properties": {
522
+ "type": {
523
+ "type": "string",
524
+ "const": "variable"
525
+ },
526
+ "variableName": {
527
+ "type": "string"
528
+ }
529
+ },
530
+ "required": ["type", "variableName"],
531
+ "additionalProperties": false
532
+ }
533
+ ]
534
+ },
535
+ "valueTo": {
536
+ "description": "Upper filter value",
537
+ "anyOf": [
538
+ {
539
+ "type": "string"
540
+ },
541
+ {
542
+ "type": "object",
543
+ "properties": {
544
+ "type": {
545
+ "type": "string",
546
+ "const": "variable"
547
+ },
548
+ "variableName": {
549
+ "type": "string"
550
+ }
551
+ },
552
+ "required": ["type", "variableName"],
553
+ "additionalProperties": false
554
+ }
555
+ ]
556
+ }
557
+ },
558
+ "required": ["measureName", "operator", "valueFrom", "valueTo"],
559
+ "additionalProperties": false
560
+ },
561
+ {
562
+ "type": "object",
563
+ "properties": {
564
+ "measureName": {
565
+ "description": "Visible measure name or label",
566
+ "type": "string"
567
+ },
568
+ "operator": {
569
+ "description": "Filter operator that requires a list of values",
570
+ "type": "string",
571
+ "enum": ["inList", "excludedFromList"]
572
+ },
573
+ "values": {
574
+ "description": "Filter values",
575
+ "minItems": 1,
576
+ "type": "array",
577
+ "items": {
578
+ "type": "string"
579
+ }
580
+ }
581
+ },
582
+ "required": ["measureName", "operator", "values"],
583
+ "additionalProperties": false
584
+ },
585
+ {
586
+ "type": "object",
587
+ "properties": {
588
+ "measureName": {
589
+ "description": "Visible measure name or label",
590
+ "type": "string"
591
+ },
592
+ "operator": {
593
+ "description": "Filter operator that does not require values",
594
+ "type": "string",
595
+ "enum": ["isNull", "notNull"]
596
+ }
597
+ },
598
+ "required": ["measureName", "operator"],
599
+ "additionalProperties": false
600
+ }
601
+ ]
602
+ }
603
+ ```
604
+
605
+ ## `changeMeasureAggregation`
606
+
607
+ Measure aggregation
608
+
609
+ Change how a measure is aggregated
610
+
611
+ **Payload schema**
612
+
613
+ ```json
614
+ {
615
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
616
+ "title": "Change measure aggregation schema",
617
+ "type": "object",
618
+ "properties": {
619
+ "dataItemInternalKey": {
620
+ "description": "Internal key of the data item of the measure to be updated",
621
+ "type": "string"
622
+ },
623
+ "dataItemUniqueSignature": {
624
+ "description": "Unique signature of the data item of the measure to be updated",
625
+ "type": "string"
626
+ },
627
+ "aggregation": {
628
+ "description": "Aggregation function to be used for the measure",
629
+ "type": "string",
630
+ "minLength": 1
631
+ }
632
+ },
633
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "aggregation"],
634
+ "additionalProperties": false
635
+ }
636
+ ```
637
+
638
+ ## `clearMeasureFilter`
639
+
640
+ Clear measure filter
641
+
642
+ Clear measure filters before aggregation. Use fieldKey for one field; omit it for all.
643
+
644
+ **Payload schema**
645
+
646
+ ```json
647
+ {
648
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
649
+ "description": "Clear measure filters before aggregation. Use fieldKey for one field; omit it for all.",
650
+ "title": "Clear measure filter schema",
651
+ "type": "object",
652
+ "properties": {
653
+ "measureName": {
654
+ "description": "Visible measure name or label",
655
+ "type": "string"
656
+ },
657
+ "fieldKey": {
658
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label. Omit to clear all filters on the measure.",
659
+ "type": "string"
660
+ }
661
+ },
662
+ "required": ["measureName"],
663
+ "additionalProperties": false
664
+ }
665
+ ```
666
+
667
+ ## `clearResultFilter`
668
+
669
+ Clear result filter
670
+
671
+ Clear all result filters for one measure.
672
+
673
+ **Payload schema**
674
+
675
+ ```json
676
+ {
677
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
678
+ "description": "Clear all result filters for one measure.",
679
+ "title": "Clear result filter schema",
680
+ "type": "object",
681
+ "properties": {
682
+ "measureName": {
683
+ "description": "Visible measure name or label",
684
+ "type": "string"
685
+ }
686
+ },
687
+ "required": ["measureName"],
688
+ "additionalProperties": false
689
+ }
690
+ ```
691
+
692
+ ## `duplicateMeasure`
693
+
694
+ Duplicate measure
695
+
696
+ Create a copy of an existing measure
697
+
698
+ **Payload schema**
699
+
700
+ ```json
701
+ {
702
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
703
+ "title": "Duplicate measure schema",
704
+ "type": "object",
705
+ "properties": {
706
+ "dataItemInternalKey": {
707
+ "description": "Internal key of the data item of the measure to be duplicated",
708
+ "type": "string"
709
+ },
710
+ "dataItemUniqueSignature": {
711
+ "description": "Unique signature of the data item of the measure to be duplicated",
712
+ "type": "string"
713
+ }
714
+ },
715
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
716
+ "additionalProperties": false
717
+ }
718
+ ```
719
+
720
+ ## `enableCustomNullValue`
721
+
722
+ Enable custom null value
723
+
724
+ Enable custom text display for null or empty values
725
+
726
+ **Payload schema**
727
+
728
+ ```json
729
+ {
730
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
731
+ "title": "Enable custom null value schema",
732
+ "type": "boolean"
733
+ }
734
+ ```
735
+
736
+ ## `enableQueryTimeout`
737
+
738
+ Enable query timeout
739
+
740
+ Enable or disable query timeout to limit long-running queries
741
+
742
+ **Payload schema**
743
+
744
+ ```json
745
+ {
746
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
747
+ "title": "Query timeout enabled schema",
748
+ "type": "boolean"
749
+ }
750
+ ```
751
+
752
+ ## `removeMeasure`
753
+
754
+ Remove measure
755
+
756
+ Remove a measure from the chart
757
+
758
+ **Payload schema**
759
+
760
+ ```json
761
+ {
762
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
763
+ "title": "Remove measure schema",
764
+ "type": "object",
765
+ "properties": {
766
+ "dataItemInternalKey": {
767
+ "description": "Internal key of the data item of the measure to be removed",
768
+ "type": "string"
769
+ },
770
+ "dataItemUniqueSignature": {
771
+ "description": "Unique signature of the data item of the measure to be removed",
772
+ "type": "string"
773
+ }
774
+ },
775
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
776
+ "additionalProperties": false
777
+ }
778
+ ```
779
+
780
+ ## `removeMeasureAdvancedAdditionalDimensionDataField`
781
+
782
+ Remove advanced bottom dimension
783
+
784
+ Remove bottom dimension field from nested ratio advanced calculation
785
+
786
+ **Payload schema**
787
+
788
+ ```json
789
+ {
790
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
791
+ "title": "Remove measure advanced additional dimension field schema",
792
+ "type": "object",
793
+ "properties": {
794
+ "dataItemInternalKey": {
795
+ "description": "Internal key of the data item of the measure to be updated",
796
+ "type": "string"
797
+ },
798
+ "dataItemUniqueSignature": {
799
+ "description": "Unique signature of the data item of the measure to be updated",
800
+ "type": "string"
801
+ },
802
+ "collectionKey": {
803
+ "description": "Measure collection key",
804
+ "type": "string",
805
+ "enum": ["measures", "supportingMeasures"]
806
+ },
807
+ "advancedOperationKey": {
808
+ "description": "Advanced operation key",
809
+ "type": "string",
810
+ "enum": ["advancedCalculation", "nestedCalculation"]
811
+ },
812
+ "internalKey": {
813
+ "description": "Internal key of the bottom dimension field to be removed",
814
+ "type": "string"
815
+ }
816
+ },
817
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "internalKey"],
818
+ "additionalProperties": false
819
+ }
820
+ ```
821
+
822
+ ## `removeMeasureAdvancedCompareMeasure`
823
+
824
+ Remove advanced compare measure
825
+
826
+ Remove compare measure from advanced calculation
827
+
828
+ **Payload schema**
829
+
830
+ ```json
831
+ {
832
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
833
+ "title": "Remove measure advanced compare measure schema",
834
+ "type": "object",
835
+ "properties": {
836
+ "dataItemInternalKey": {
837
+ "description": "Internal key of the data item of the measure to be updated",
838
+ "type": "string"
839
+ },
840
+ "dataItemUniqueSignature": {
841
+ "description": "Unique signature of the data item of the measure to be updated",
842
+ "type": "string"
843
+ },
844
+ "collectionKey": {
845
+ "description": "Measure collection key",
846
+ "type": "string",
847
+ "enum": ["measures", "supportingMeasures"]
848
+ },
849
+ "advancedOperationKey": {
850
+ "description": "Advanced operation key",
851
+ "type": "string",
852
+ "enum": ["advancedCalculation", "nestedCalculation"]
853
+ }
854
+ },
855
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
856
+ "additionalProperties": false
857
+ }
858
+ ```
859
+
860
+ ## `removeMeasureAdvancedDimensionDataField`
861
+
862
+ Remove advanced additional dimension
863
+
864
+ Remove additional dimension field from nested advanced calculations
865
+
866
+ **Payload schema**
867
+
868
+ ```json
869
+ {
870
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
871
+ "title": "Remove measure advanced dimension field schema",
872
+ "type": "object",
873
+ "properties": {
874
+ "dataItemInternalKey": {
875
+ "description": "Internal key of the data item of the measure to be updated",
876
+ "type": "string"
877
+ },
878
+ "dataItemUniqueSignature": {
879
+ "description": "Unique signature of the data item of the measure to be updated",
880
+ "type": "string"
881
+ },
882
+ "collectionKey": {
883
+ "description": "Measure collection key",
884
+ "type": "string",
885
+ "enum": ["measures", "supportingMeasures"]
886
+ },
887
+ "advancedOperationKey": {
888
+ "description": "Advanced operation key",
889
+ "type": "string",
890
+ "enum": ["advancedCalculation", "nestedCalculation"]
891
+ },
892
+ "internalKey": {
893
+ "description": "Internal key of the dimension field to be removed",
894
+ "type": "string"
895
+ }
896
+ },
897
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "internalKey"],
898
+ "additionalProperties": false
899
+ }
900
+ ```
901
+
902
+ ## `setComparisonFontColor`
903
+
904
+ Comparison font color
905
+
906
+ Change the color of the comparison value display
907
+
908
+ **Payload schema**
909
+
910
+ ```json
911
+ {
912
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
913
+ "description": "Font color (hex, with optional alpha)",
914
+ "title": "Number comparison font color schema",
915
+ "anyOf": [
916
+ {
917
+ "type": "string",
918
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
919
+ },
920
+ {
921
+ "type": "null"
922
+ }
923
+ ]
924
+ }
925
+ ```
926
+
927
+ ## `setComparisonFontFamily`
928
+
929
+ Comparison font family
930
+
931
+ Change the font family for the comparison value display
932
+
933
+ **Payload schema**
934
+
935
+ ```json
936
+ {
937
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
938
+ "title": "Number comparison font family schema",
939
+ "anyOf": [
940
+ {
941
+ "type": "string"
942
+ },
943
+ {
944
+ "type": "null"
945
+ }
946
+ ]
947
+ }
948
+ ```
949
+
950
+ ## `setComparisonFontStyle`
951
+
952
+ Comparison font style
953
+
954
+ Apply font styling to the comparison value
955
+
956
+ **Payload schema**
957
+
958
+ ```json
959
+ {
960
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
961
+ "title": "Number comparison font style schema",
962
+ "type": "object",
963
+ "properties": {
964
+ "weight": {
965
+ "description": "Font weight",
966
+ "anyOf": [
967
+ {
968
+ "type": "number"
969
+ },
970
+ {
971
+ "type": "null"
972
+ }
973
+ ]
974
+ },
975
+ "bold": {
976
+ "description": "Bold font. Should take precedence over weight",
977
+ "type": "boolean"
978
+ },
979
+ "italic": {
980
+ "type": "boolean"
981
+ },
982
+ "underlined": {
983
+ "type": "boolean"
984
+ },
985
+ "strikethrough": {
986
+ "type": "boolean"
987
+ },
988
+ "fontFamily": {
989
+ "anyOf": [
990
+ {
991
+ "type": "string"
992
+ },
993
+ {
994
+ "type": "null"
995
+ }
996
+ ]
997
+ },
998
+ "fontColor": {
999
+ "description": "Font color (hex, with optional alpha)",
1000
+ "anyOf": [
1001
+ {
1002
+ "type": "string",
1003
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1004
+ },
1005
+ {
1006
+ "type": "null"
1007
+ }
1008
+ ]
1009
+ },
1010
+ "relativeFontSizePercentage": {
1011
+ "description": "Comparison font size as a percentage of the main number font size",
1012
+ "type": "number",
1013
+ "minimum": 0,
1014
+ "maximum": 200
1015
+ }
1016
+ },
1017
+ "additionalProperties": false
1018
+ }
1019
+ ```
1020
+
1021
+ ## `setComparisonFontWeight`
1022
+
1023
+ Comparison font weight
1024
+
1025
+ Set the font weight of the comparison value display
1026
+
1027
+ **Payload schema**
1028
+
1029
+ ```json
1030
+ {
1031
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1032
+ "description": "Font weight",
1033
+ "title": "Number comparison font weight schema",
1034
+ "anyOf": [
1035
+ {
1036
+ "type": "number"
1037
+ },
1038
+ {
1039
+ "type": "null"
1040
+ }
1041
+ ]
1042
+ }
1043
+ ```
1044
+
1045
+ ## `setComparisonGap`
1046
+
1047
+ Comparison gap
1048
+
1049
+ Set the horizontal spacing between the main number and the comparison (none, small-gap, space-around, space-between); only applies when comparison is positioned left or right
1050
+
1051
+ **Payload schema**
1052
+
1053
+ ```json
1054
+ {
1055
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1056
+ "description": "Horizontal spacing between number and comparison; only applies for left/right comparison",
1057
+ "title": "Number comparison gap schema",
1058
+ "type": "string",
1059
+ "enum": ["none", "small-gap", "space-around", "space-between"]
1060
+ }
1061
+ ```
1062
+
1063
+ ## `setComparisonPosition`
1064
+
1065
+ Comparison position
1066
+
1067
+ Set the position of the comparison value relative to the main number
1068
+
1069
+ **Payload schema**
1070
+
1071
+ ```json
1072
+ {
1073
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1074
+ "title": "Number comparison position schema",
1075
+ "type": "string",
1076
+ "enum": ["left", "right", "top", "bottom", "center"]
1077
+ }
1078
+ ```
1079
+
1080
+ ## `setComparisonRelativeFontSizePercentage`
1081
+
1082
+ Comparison relative font size
1083
+
1084
+ Adjust the comparison font size as a percentage of the main number font size
1085
+
1086
+ **Payload schema**
1087
+
1088
+ ```json
1089
+ {
1090
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1091
+ "description": "Comparison font size as a percentage of the main number font size",
1092
+ "title": "Number comparison relative font size percentage schema",
1093
+ "type": "number",
1094
+ "minimum": 0,
1095
+ "maximum": 200
1096
+ }
1097
+ ```
1098
+
1099
+ ## `setCustomNullValue`
1100
+
1101
+ Custom null value
1102
+
1103
+ Set what text to display for null or empty values
1104
+
1105
+ **Payload schema**
1106
+
1107
+ ```json
1108
+ {
1109
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1110
+ "title": "Set custom null value schema",
1111
+ "anyOf": [
1112
+ {
1113
+ "anyOf": [
1114
+ {
1115
+ "type": "string"
1116
+ },
1117
+ {
1118
+ "type": "object",
1119
+ "properties": {
1120
+ "type": {
1121
+ "type": "string",
1122
+ "const": "variable"
1123
+ },
1124
+ "variableName": {
1125
+ "type": "string"
1126
+ }
1127
+ },
1128
+ "required": ["type", "variableName"],
1129
+ "additionalProperties": false
1130
+ }
1131
+ ]
1132
+ },
1133
+ {
1134
+ "type": "null"
1135
+ }
1136
+ ]
1137
+ }
1138
+ ```
1139
+
1140
+ ## `setHorizontalAlign`
1141
+
1142
+ Horizontal align
1143
+
1144
+ Set horizontal alignment of the number
1145
+
1146
+ **Payload schema**
1147
+
1148
+ ```json
1149
+ {
1150
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1151
+ "title": "Number horizontal align schema",
1152
+ "type": "string",
1153
+ "enum": ["auto", "left", "center", "right"]
1154
+ }
1155
+ ```
1156
+
1157
+ ## `setIconPosition`
1158
+
1159
+ Icon position
1160
+
1161
+ Set the position of the icon relative to the number
1162
+
1163
+ **Payload schema**
1164
+
1165
+ ```json
1166
+ {
1167
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1168
+ "title": "Number icon position schema",
1169
+ "type": "string",
1170
+ "enum": ["left", "right", "top", "bottom", "center"]
1171
+ }
1172
+ ```
1173
+
1174
+ ## `setMeasureAdvancedAdditionalAggregation`
1175
+
1176
+ Advanced additional aggregation
1177
+
1178
+ Set additional aggregation used by nested ratio advanced calculation
1179
+
1180
+ **Payload schema**
1181
+
1182
+ ```json
1183
+ {
1184
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1185
+ "title": "Measure advanced additional aggregation schema",
1186
+ "type": "object",
1187
+ "properties": {
1188
+ "dataItemInternalKey": {
1189
+ "description": "Internal key of the data item of the measure to be updated",
1190
+ "type": "string"
1191
+ },
1192
+ "dataItemUniqueSignature": {
1193
+ "description": "Unique signature of the data item of the measure to be updated",
1194
+ "type": "string"
1195
+ },
1196
+ "collectionKey": {
1197
+ "description": "Measure collection key",
1198
+ "type": "string",
1199
+ "enum": ["measures", "supportingMeasures"]
1200
+ },
1201
+ "advancedOperationKey": {
1202
+ "description": "Advanced operation key",
1203
+ "type": "string",
1204
+ "enum": ["advancedCalculation", "nestedCalculation"]
1205
+ },
1206
+ "additionalAggregation": {
1207
+ "type": "string",
1208
+ "enum": ["SUM", "AVG", "MIN", "MAX"]
1209
+ }
1210
+ },
1211
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "additionalAggregation"],
1212
+ "additionalProperties": false
1213
+ }
1214
+ ```
1215
+
1216
+ ## `setMeasureAdvancedAggregation`
1217
+
1218
+ Advanced aggregation
1219
+
1220
+ Set aggregation used by advanced calculation for a measure
1221
+
1222
+ **Payload schema**
1223
+
1224
+ ```json
1225
+ {
1226
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1227
+ "title": "Measure advanced aggregation schema",
1228
+ "type": "object",
1229
+ "properties": {
1230
+ "dataItemInternalKey": {
1231
+ "description": "Internal key of the data item of the measure to be updated",
1232
+ "type": "string"
1233
+ },
1234
+ "dataItemUniqueSignature": {
1235
+ "description": "Unique signature of the data item of the measure to be updated",
1236
+ "type": "string"
1237
+ },
1238
+ "collectionKey": {
1239
+ "description": "Measure collection key",
1240
+ "type": "string",
1241
+ "enum": ["measures", "supportingMeasures"]
1242
+ },
1243
+ "advancedOperationKey": {
1244
+ "description": "Advanced operation key",
1245
+ "type": "string",
1246
+ "enum": ["advancedCalculation", "nestedCalculation"]
1247
+ },
1248
+ "aggregation": {
1249
+ "type": "string",
1250
+ "enum": ["SUM", "AVG", "MIN", "MAX", "PERCENTILE", "OUTLIERS", "CONTROL_VALUE"]
1251
+ }
1252
+ },
1253
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "aggregation"],
1254
+ "additionalProperties": false
1255
+ }
1256
+ ```
1257
+
1258
+ ## `setMeasureAdvancedCalculationType`
1259
+
1260
+ Advanced calculation type
1261
+
1262
+ Set advanced calculation type for a measure
1263
+
1264
+ **Payload schema**
1265
+
1266
+ ```json
1267
+ {
1268
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1269
+ "title": "Number advanced calculation type schema",
1270
+ "type": "object",
1271
+ "properties": {
1272
+ "dataItemInternalKey": {
1273
+ "description": "Internal key of the data item of the measure to be updated",
1274
+ "type": "string"
1275
+ },
1276
+ "dataItemUniqueSignature": {
1277
+ "description": "Unique signature of the data item of the measure to be updated",
1278
+ "type": "string"
1279
+ },
1280
+ "advancedCalculationType": {
1281
+ "type": "string",
1282
+ "enum": [
1283
+ "nestedCalculation",
1284
+ "nestedRatio",
1285
+ "nestedCorrelation",
1286
+ "value",
1287
+ "diff",
1288
+ "ratio",
1289
+ "growth",
1290
+ "apg",
1291
+ "cagr"
1292
+ ]
1293
+ }
1294
+ },
1295
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "advancedCalculationType"],
1296
+ "additionalProperties": false
1297
+ }
1298
+ ```
1299
+
1300
+ ## `setMeasureAdvancedCompareMeasure`
1301
+
1302
+ Advanced compare measure
1303
+
1304
+ Set compare measure used by accumulated growth or nested correlation
1305
+
1306
+ **Payload schema**
1307
+
1308
+ ```json
1309
+ {
1310
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1311
+ "title": "Set measure advanced compare measure schema",
1312
+ "type": "object",
1313
+ "properties": {
1314
+ "dataItemInternalKey": {
1315
+ "description": "Internal key of the data item of the measure to be updated",
1316
+ "type": "string"
1317
+ },
1318
+ "dataItemUniqueSignature": {
1319
+ "description": "Unique signature of the data item of the measure to be updated",
1320
+ "type": "string"
1321
+ },
1322
+ "collectionKey": {
1323
+ "description": "Measure collection key",
1324
+ "type": "string",
1325
+ "enum": ["measures", "supportingMeasures"]
1326
+ },
1327
+ "advancedOperationKey": {
1328
+ "description": "Advanced operation key",
1329
+ "type": "string",
1330
+ "enum": ["advancedCalculation", "nestedCalculation"]
1331
+ },
1332
+ "key": {
1333
+ "description": "Engine key of the compare measure field",
1334
+ "type": "string"
1335
+ },
1336
+ "aggregation": {
1337
+ "type": "string",
1338
+ "enum": ["SUM", "AVG", "MIN", "MAX", "PERCENTILE", "OUTLIERS", "CONTROL_VALUE"]
1339
+ },
1340
+ "parameters": {
1341
+ "anyOf": [
1342
+ {
1343
+ "type": "object",
1344
+ "propertyNames": {
1345
+ "type": "string"
1346
+ },
1347
+ "additionalProperties": {
1348
+ "type": "object",
1349
+ "properties": {
1350
+ "value": {
1351
+ "anyOf": [
1352
+ {
1353
+ "anyOf": [
1354
+ {
1355
+ "type": "string"
1356
+ },
1357
+ {
1358
+ "type": "object",
1359
+ "properties": {
1360
+ "type": {
1361
+ "type": "string",
1362
+ "const": "variable"
1363
+ },
1364
+ "variableName": {
1365
+ "type": "string"
1366
+ }
1367
+ },
1368
+ "required": ["type", "variableName"],
1369
+ "additionalProperties": false
1370
+ }
1371
+ ]
1372
+ },
1373
+ {
1374
+ "anyOf": [
1375
+ {
1376
+ "type": "number"
1377
+ },
1378
+ {
1379
+ "type": "object",
1380
+ "properties": {
1381
+ "type": {
1382
+ "type": "string",
1383
+ "const": "variable"
1384
+ },
1385
+ "variableName": {
1386
+ "type": "string"
1387
+ }
1388
+ },
1389
+ "required": ["type", "variableName"],
1390
+ "additionalProperties": false
1391
+ }
1392
+ ]
1393
+ },
1394
+ {
1395
+ "anyOf": [
1396
+ {
1397
+ "type": "boolean"
1398
+ },
1399
+ {
1400
+ "type": "object",
1401
+ "properties": {
1402
+ "type": {
1403
+ "type": "string",
1404
+ "const": "variable"
1405
+ },
1406
+ "variableName": {
1407
+ "type": "string"
1408
+ }
1409
+ },
1410
+ "required": ["type", "variableName"],
1411
+ "additionalProperties": false
1412
+ }
1413
+ ]
1414
+ }
1415
+ ]
1416
+ },
1417
+ "dataType": {
1418
+ "type": "string",
1419
+ "enum": [
1420
+ "string",
1421
+ "int",
1422
+ "float",
1423
+ "boolean",
1424
+ "date",
1425
+ "millisec",
1426
+ "millisec_tz",
1427
+ "timestamp",
1428
+ "timestamp_tz"
1429
+ ]
1430
+ }
1431
+ },
1432
+ "required": ["value"],
1433
+ "additionalProperties": false
1434
+ }
1435
+ },
1436
+ {
1437
+ "type": "null"
1438
+ }
1439
+ ]
1440
+ }
1441
+ },
1442
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "key", "aggregation"],
1443
+ "additionalProperties": false
1444
+ }
1445
+ ```
1446
+
1447
+ ## `setMeasureAdvancedComparisonType`
1448
+
1449
+ Advanced comparison type
1450
+
1451
+ Set comparison type for period-over-correlation
1452
+
1453
+ **Payload schema**
1454
+
1455
+ ```json
1456
+ {
1457
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1458
+ "title": "Measure advanced comparison type schema",
1459
+ "type": "object",
1460
+ "properties": {
1461
+ "dataItemInternalKey": {
1462
+ "description": "Internal key of the data item of the measure to be updated",
1463
+ "type": "string"
1464
+ },
1465
+ "dataItemUniqueSignature": {
1466
+ "description": "Unique signature of the data item of the measure to be updated",
1467
+ "type": "string"
1468
+ },
1469
+ "collectionKey": {
1470
+ "description": "Measure collection key",
1471
+ "type": "string",
1472
+ "enum": ["measures", "supportingMeasures"]
1473
+ },
1474
+ "advancedOperationKey": {
1475
+ "description": "Advanced operation key",
1476
+ "type": "string",
1477
+ "enum": ["advancedCalculation", "nestedCalculation"]
1478
+ },
1479
+ "comparisonType": {
1480
+ "type": "string",
1481
+ "enum": ["absolute", "percentage", "naturalLog"]
1482
+ }
1483
+ },
1484
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "comparisonType"],
1485
+ "additionalProperties": false
1486
+ }
1487
+ ```
1488
+
1489
+ ## `setMeasureAdvancedDense`
1490
+
1491
+ Advanced dense rank
1492
+
1493
+ Enable or disable dense rank
1494
+
1495
+ **Payload schema**
1496
+
1497
+ ```json
1498
+ {
1499
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1500
+ "title": "Measure advanced dense schema",
1501
+ "type": "object",
1502
+ "properties": {
1503
+ "dataItemInternalKey": {
1504
+ "description": "Internal key of the data item of the measure to be updated",
1505
+ "type": "string"
1506
+ },
1507
+ "dataItemUniqueSignature": {
1508
+ "description": "Unique signature of the data item of the measure to be updated",
1509
+ "type": "string"
1510
+ },
1511
+ "collectionKey": {
1512
+ "description": "Measure collection key",
1513
+ "type": "string",
1514
+ "enum": ["measures", "supportingMeasures"]
1515
+ },
1516
+ "advancedOperationKey": {
1517
+ "description": "Advanced operation key",
1518
+ "type": "string",
1519
+ "enum": ["advancedCalculation", "nestedCalculation"]
1520
+ },
1521
+ "dense": {
1522
+ "type": "boolean"
1523
+ }
1524
+ },
1525
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "dense"],
1526
+ "additionalProperties": false
1527
+ }
1528
+ ```
1529
+
1530
+ ## `setMeasureAdvancedDimensionsIds`
1531
+
1532
+ Advanced dimensions
1533
+
1534
+ Set dimensions used by advanced calculation
1535
+
1536
+ **Payload schema**
1537
+
1538
+ ```json
1539
+ {
1540
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1541
+ "title": "Measure advanced dimensions schema",
1542
+ "type": "object",
1543
+ "properties": {
1544
+ "dataItemInternalKey": {
1545
+ "description": "Internal key of the data item of the measure to be updated",
1546
+ "type": "string"
1547
+ },
1548
+ "dataItemUniqueSignature": {
1549
+ "description": "Unique signature of the data item of the measure to be updated",
1550
+ "type": "string"
1551
+ },
1552
+ "collectionKey": {
1553
+ "description": "Measure collection key",
1554
+ "type": "string",
1555
+ "enum": ["measures", "supportingMeasures"]
1556
+ },
1557
+ "advancedOperationKey": {
1558
+ "description": "Advanced operation key",
1559
+ "type": "string",
1560
+ "enum": ["advancedCalculation", "nestedCalculation"]
1561
+ },
1562
+ "dimensionsIds": {
1563
+ "type": "array",
1564
+ "items": {
1565
+ "type": "string"
1566
+ }
1567
+ }
1568
+ },
1569
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "dimensionsIds"],
1570
+ "additionalProperties": false
1571
+ }
1572
+ ```
1573
+
1574
+ ## `setMeasureAdvancedGroupType`
1575
+
1576
+ Advanced group type
1577
+
1578
+ Set comparison group type for share total advanced calculation
1579
+
1580
+ **Payload schema**
1581
+
1582
+ ```json
1583
+ {
1584
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1585
+ "title": "Measure advanced group type schema",
1586
+ "type": "object",
1587
+ "properties": {
1588
+ "dataItemInternalKey": {
1589
+ "description": "Internal key of the data item of the measure to be updated",
1590
+ "type": "string"
1591
+ },
1592
+ "dataItemUniqueSignature": {
1593
+ "description": "Unique signature of the data item of the measure to be updated",
1594
+ "type": "string"
1595
+ },
1596
+ "collectionKey": {
1597
+ "description": "Measure collection key",
1598
+ "type": "string",
1599
+ "enum": ["measures", "supportingMeasures"]
1600
+ },
1601
+ "advancedOperationKey": {
1602
+ "description": "Advanced operation key",
1603
+ "type": "string",
1604
+ "enum": ["advancedCalculation", "nestedCalculation"]
1605
+ },
1606
+ "groupType": {
1607
+ "type": "string",
1608
+ "enum": ["value", "diff", "ratio", "growth"]
1609
+ }
1610
+ },
1611
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "groupType"],
1612
+ "additionalProperties": false
1613
+ }
1614
+ ```
1615
+
1616
+ ## `setMeasureAdvancedNonTimePeriod`
1617
+
1618
+ Advanced nested time dimension
1619
+
1620
+ Enable or disable nested time dimension
1621
+
1622
+ **Payload schema**
1623
+
1624
+ ```json
1625
+ {
1626
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1627
+ "title": "Measure advanced nested time dimension schema",
1628
+ "type": "object",
1629
+ "properties": {
1630
+ "dataItemInternalKey": {
1631
+ "description": "Internal key of the data item of the measure to be updated",
1632
+ "type": "string"
1633
+ },
1634
+ "dataItemUniqueSignature": {
1635
+ "description": "Unique signature of the data item of the measure to be updated",
1636
+ "type": "string"
1637
+ },
1638
+ "collectionKey": {
1639
+ "description": "Measure collection key",
1640
+ "type": "string",
1641
+ "enum": ["measures", "supportingMeasures"]
1642
+ },
1643
+ "advancedOperationKey": {
1644
+ "description": "Advanced operation key",
1645
+ "type": "string",
1646
+ "enum": ["advancedCalculation", "nestedCalculation"]
1647
+ },
1648
+ "nonTimePeriod": {
1649
+ "type": "boolean"
1650
+ }
1651
+ },
1652
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "nonTimePeriod"],
1653
+ "additionalProperties": false
1654
+ }
1655
+ ```
1656
+
1657
+ ## `setMeasureAdvancedNonTimePeriodGranularity`
1658
+
1659
+ Advanced non-time period granularity
1660
+
1661
+ Set non-time period granularity for inter-record calculations
1662
+
1663
+ **Payload schema**
1664
+
1665
+ ```json
1666
+ {
1667
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1668
+ "title": "Measure advanced non-time period granularity schema",
1669
+ "type": "object",
1670
+ "properties": {
1671
+ "dataItemInternalKey": {
1672
+ "description": "Internal key of the data item of the measure to be updated",
1673
+ "type": "string"
1674
+ },
1675
+ "dataItemUniqueSignature": {
1676
+ "description": "Unique signature of the data item of the measure to be updated",
1677
+ "type": "string"
1678
+ },
1679
+ "collectionKey": {
1680
+ "description": "Measure collection key",
1681
+ "type": "string",
1682
+ "enum": ["measures", "supportingMeasures"]
1683
+ },
1684
+ "advancedOperationKey": {
1685
+ "description": "Advanced operation key",
1686
+ "type": "string",
1687
+ "enum": ["advancedCalculation", "nestedCalculation"]
1688
+ },
1689
+ "nonTimePeriodGranularity": {
1690
+ "type": "string",
1691
+ "enum": ["day", "week", "month", "quarter", "year"]
1692
+ }
1693
+ },
1694
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "nonTimePeriodGranularity"],
1695
+ "additionalProperties": false
1696
+ }
1697
+ ```
1698
+
1699
+ ## `setMeasureAdvancedNullIfNotEnoughValues`
1700
+
1701
+ Advanced null if not enough values
1702
+
1703
+ Enable or disable null-if-not-enough-values for moving calculation
1704
+
1705
+ **Payload schema**
1706
+
1707
+ ```json
1708
+ {
1709
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1710
+ "title": "Measure advanced null if not enough values schema",
1711
+ "type": "object",
1712
+ "properties": {
1713
+ "dataItemInternalKey": {
1714
+ "description": "Internal key of the data item of the measure to be updated",
1715
+ "type": "string"
1716
+ },
1717
+ "dataItemUniqueSignature": {
1718
+ "description": "Unique signature of the data item of the measure to be updated",
1719
+ "type": "string"
1720
+ },
1721
+ "collectionKey": {
1722
+ "description": "Measure collection key",
1723
+ "type": "string",
1724
+ "enum": ["measures", "supportingMeasures"]
1725
+ },
1726
+ "advancedOperationKey": {
1727
+ "description": "Advanced operation key",
1728
+ "type": "string",
1729
+ "enum": ["advancedCalculation", "nestedCalculation"]
1730
+ },
1731
+ "nullIfNotEnoughValues": {
1732
+ "type": "boolean"
1733
+ }
1734
+ },
1735
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "nullIfNotEnoughValues"],
1736
+ "additionalProperties": false
1737
+ }
1738
+ ```
1739
+
1740
+ ## `setMeasureAdvancedOffset`
1741
+
1742
+ Advanced compare with period offset
1743
+
1744
+ Set compare-with-period offset for advanced calculation
1745
+
1746
+ **Payload schema**
1747
+
1748
+ ```json
1749
+ {
1750
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1751
+ "title": "Measure advanced offset schema",
1752
+ "type": "object",
1753
+ "properties": {
1754
+ "dataItemInternalKey": {
1755
+ "description": "Internal key of the data item of the measure to be updated",
1756
+ "type": "string"
1757
+ },
1758
+ "dataItemUniqueSignature": {
1759
+ "description": "Unique signature of the data item of the measure to be updated",
1760
+ "type": "string"
1761
+ },
1762
+ "collectionKey": {
1763
+ "description": "Measure collection key",
1764
+ "type": "string",
1765
+ "enum": ["measures", "supportingMeasures"]
1766
+ },
1767
+ "advancedOperationKey": {
1768
+ "description": "Advanced operation key",
1769
+ "type": "string",
1770
+ "enum": ["advancedCalculation", "nestedCalculation"]
1771
+ },
1772
+ "offset": {
1773
+ "anyOf": [
1774
+ {
1775
+ "type": "number"
1776
+ },
1777
+ {
1778
+ "type": "object",
1779
+ "properties": {
1780
+ "type": {
1781
+ "type": "string",
1782
+ "const": "variable"
1783
+ },
1784
+ "variableName": {
1785
+ "type": "string"
1786
+ }
1787
+ },
1788
+ "required": ["type", "variableName"],
1789
+ "additionalProperties": false
1790
+ }
1791
+ ]
1792
+ }
1793
+ },
1794
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "offset"],
1795
+ "additionalProperties": false
1796
+ }
1797
+ ```
1798
+
1799
+ ## `setMeasureAdvancedParameter`
1800
+
1801
+ Advanced parameter
1802
+
1803
+ Set value for advanced operation parameter
1804
+
1805
+ **Payload schema**
1806
+
1807
+ ```json
1808
+ {
1809
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1810
+ "title": "Set measure advanced parameter schema",
1811
+ "type": "object",
1812
+ "properties": {
1813
+ "dataItemInternalKey": {
1814
+ "description": "Internal key of the data item of the measure to be updated",
1815
+ "type": "string"
1816
+ },
1817
+ "dataItemUniqueSignature": {
1818
+ "description": "Unique signature of the data item of the measure to be updated",
1819
+ "type": "string"
1820
+ },
1821
+ "collectionKey": {
1822
+ "description": "Measure collection key",
1823
+ "type": "string",
1824
+ "enum": ["measures", "supportingMeasures"]
1825
+ },
1826
+ "advancedOperationKey": {
1827
+ "description": "Advanced operation key",
1828
+ "type": "string",
1829
+ "enum": ["advancedCalculation", "nestedCalculation"]
1830
+ },
1831
+ "variableName": {
1832
+ "description": "Name of advanced operation parameter to update",
1833
+ "type": "string"
1834
+ },
1835
+ "value": {
1836
+ "type": "object",
1837
+ "properties": {
1838
+ "value": {
1839
+ "anyOf": [
1840
+ {
1841
+ "anyOf": [
1842
+ {
1843
+ "type": "string"
1844
+ },
1845
+ {
1846
+ "type": "object",
1847
+ "properties": {
1848
+ "type": {
1849
+ "type": "string",
1850
+ "const": "variable"
1851
+ },
1852
+ "variableName": {
1853
+ "type": "string"
1854
+ }
1855
+ },
1856
+ "required": ["type", "variableName"],
1857
+ "additionalProperties": false
1858
+ }
1859
+ ]
1860
+ },
1861
+ {
1862
+ "anyOf": [
1863
+ {
1864
+ "type": "number"
1865
+ },
1866
+ {
1867
+ "type": "object",
1868
+ "properties": {
1869
+ "type": {
1870
+ "type": "string",
1871
+ "const": "variable"
1872
+ },
1873
+ "variableName": {
1874
+ "type": "string"
1875
+ }
1876
+ },
1877
+ "required": ["type", "variableName"],
1878
+ "additionalProperties": false
1879
+ }
1880
+ ]
1881
+ },
1882
+ {
1883
+ "anyOf": [
1884
+ {
1885
+ "type": "boolean"
1886
+ },
1887
+ {
1888
+ "type": "object",
1889
+ "properties": {
1890
+ "type": {
1891
+ "type": "string",
1892
+ "const": "variable"
1893
+ },
1894
+ "variableName": {
1895
+ "type": "string"
1896
+ }
1897
+ },
1898
+ "required": ["type", "variableName"],
1899
+ "additionalProperties": false
1900
+ }
1901
+ ]
1902
+ }
1903
+ ]
1904
+ },
1905
+ "dataType": {
1906
+ "type": "string",
1907
+ "enum": ["string", "int", "float", "boolean", "date", "millisec", "millisec_tz", "timestamp", "timestamp_tz"]
1908
+ }
1909
+ },
1910
+ "required": ["value"],
1911
+ "additionalProperties": false
1912
+ }
1913
+ },
1914
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "variableName", "value"],
1915
+ "additionalProperties": false
1916
+ }
1917
+ ```
1918
+
1919
+ ## `setMeasureAdvancedPercentileApprox`
1920
+
1921
+ Advanced percentile approx
1922
+
1923
+ Enable or disable approximate percentile mode
1924
+
1925
+ **Payload schema**
1926
+
1927
+ ```json
1928
+ {
1929
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1930
+ "title": "Measure advanced percentile approx schema",
1931
+ "type": "object",
1932
+ "properties": {
1933
+ "dataItemInternalKey": {
1934
+ "description": "Internal key of the data item of the measure to be updated",
1935
+ "type": "string"
1936
+ },
1937
+ "dataItemUniqueSignature": {
1938
+ "description": "Unique signature of the data item of the measure to be updated",
1939
+ "type": "string"
1940
+ },
1941
+ "collectionKey": {
1942
+ "description": "Measure collection key",
1943
+ "type": "string",
1944
+ "enum": ["measures", "supportingMeasures"]
1945
+ },
1946
+ "advancedOperationKey": {
1947
+ "description": "Advanced operation key",
1948
+ "type": "string",
1949
+ "enum": ["advancedCalculation", "nestedCalculation"]
1950
+ },
1951
+ "percentileApprox": {
1952
+ "type": "boolean"
1953
+ }
1954
+ },
1955
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "percentileApprox"],
1956
+ "additionalProperties": false
1957
+ }
1958
+ ```
1959
+
1960
+ ## `setMeasureAdvancedPercentileContinuous`
1961
+
1962
+ Advanced percentile continuous
1963
+
1964
+ Enable or disable continuous percentile mode
1965
+
1966
+ **Payload schema**
1967
+
1968
+ ```json
1969
+ {
1970
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1971
+ "title": "Measure advanced percentile continuous schema",
1972
+ "type": "object",
1973
+ "properties": {
1974
+ "dataItemInternalKey": {
1975
+ "description": "Internal key of the data item of the measure to be updated",
1976
+ "type": "string"
1977
+ },
1978
+ "dataItemUniqueSignature": {
1979
+ "description": "Unique signature of the data item of the measure to be updated",
1980
+ "type": "string"
1981
+ },
1982
+ "collectionKey": {
1983
+ "description": "Measure collection key",
1984
+ "type": "string",
1985
+ "enum": ["measures", "supportingMeasures"]
1986
+ },
1987
+ "advancedOperationKey": {
1988
+ "description": "Advanced operation key",
1989
+ "type": "string",
1990
+ "enum": ["advancedCalculation", "nestedCalculation"]
1991
+ },
1992
+ "percentileContinuous": {
1993
+ "type": "boolean"
1994
+ }
1995
+ },
1996
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "percentileContinuous"],
1997
+ "additionalProperties": false
1998
+ }
1999
+ ```
2000
+
2001
+ ## `setMeasureAdvancedPercentileValue`
2002
+
2003
+ Advanced percentile value
2004
+
2005
+ Set percentile value for percentile aggregation
2006
+
2007
+ **Payload schema**
2008
+
2009
+ ```json
2010
+ {
2011
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2012
+ "title": "Measure advanced percentile value schema",
2013
+ "type": "object",
2014
+ "properties": {
2015
+ "dataItemInternalKey": {
2016
+ "description": "Internal key of the data item of the measure to be updated",
2017
+ "type": "string"
2018
+ },
2019
+ "dataItemUniqueSignature": {
2020
+ "description": "Unique signature of the data item of the measure to be updated",
2021
+ "type": "string"
2022
+ },
2023
+ "collectionKey": {
2024
+ "description": "Measure collection key",
2025
+ "type": "string",
2026
+ "enum": ["measures", "supportingMeasures"]
2027
+ },
2028
+ "advancedOperationKey": {
2029
+ "description": "Advanced operation key",
2030
+ "type": "string",
2031
+ "enum": ["advancedCalculation", "nestedCalculation"]
2032
+ },
2033
+ "percentileValue": {
2034
+ "anyOf": [
2035
+ {
2036
+ "type": "number"
2037
+ },
2038
+ {
2039
+ "type": "object",
2040
+ "properties": {
2041
+ "type": {
2042
+ "type": "string",
2043
+ "const": "variable"
2044
+ },
2045
+ "variableName": {
2046
+ "type": "string"
2047
+ }
2048
+ },
2049
+ "required": ["type", "variableName"],
2050
+ "additionalProperties": false
2051
+ }
2052
+ ]
2053
+ }
2054
+ },
2055
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "percentileValue"],
2056
+ "additionalProperties": false
2057
+ }
2058
+ ```
2059
+
2060
+ ## `setMeasureAdvancedPeriodsPerYear`
2061
+
2062
+ Advanced periods per year
2063
+
2064
+ Set number of periods in a year for annualized period growth
2065
+
2066
+ **Payload schema**
2067
+
2068
+ ```json
2069
+ {
2070
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2071
+ "title": "Measure advanced periods per year schema",
2072
+ "type": "object",
2073
+ "properties": {
2074
+ "dataItemInternalKey": {
2075
+ "description": "Internal key of the data item of the measure to be updated",
2076
+ "type": "string"
2077
+ },
2078
+ "dataItemUniqueSignature": {
2079
+ "description": "Unique signature of the data item of the measure to be updated",
2080
+ "type": "string"
2081
+ },
2082
+ "collectionKey": {
2083
+ "description": "Measure collection key",
2084
+ "type": "string",
2085
+ "enum": ["measures", "supportingMeasures"]
2086
+ },
2087
+ "advancedOperationKey": {
2088
+ "description": "Advanced operation key",
2089
+ "type": "string",
2090
+ "enum": ["advancedCalculation", "nestedCalculation"]
2091
+ },
2092
+ "periodsPerYear": {
2093
+ "anyOf": [
2094
+ {
2095
+ "type": "number"
2096
+ },
2097
+ {
2098
+ "type": "object",
2099
+ "properties": {
2100
+ "type": {
2101
+ "type": "string",
2102
+ "const": "variable"
2103
+ },
2104
+ "variableName": {
2105
+ "type": "string"
2106
+ }
2107
+ },
2108
+ "required": ["type", "variableName"],
2109
+ "additionalProperties": false
2110
+ }
2111
+ ]
2112
+ }
2113
+ },
2114
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "periodsPerYear"],
2115
+ "additionalProperties": false
2116
+ }
2117
+ ```
2118
+
2119
+ ## `setMeasureAdvancedRangesComparisonEnabled`
2120
+
2121
+ Advanced ranges comparison enabled
2122
+
2123
+ Enable or disable ranges comparison
2124
+
2125
+ **Payload schema**
2126
+
2127
+ ```json
2128
+ {
2129
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2130
+ "title": "Measure advanced ranges comparison enabled schema",
2131
+ "type": "object",
2132
+ "properties": {
2133
+ "dataItemInternalKey": {
2134
+ "description": "Internal key of the data item of the measure to be updated",
2135
+ "type": "string"
2136
+ },
2137
+ "dataItemUniqueSignature": {
2138
+ "description": "Unique signature of the data item of the measure to be updated",
2139
+ "type": "string"
2140
+ },
2141
+ "collectionKey": {
2142
+ "description": "Measure collection key",
2143
+ "type": "string",
2144
+ "enum": ["measures", "supportingMeasures"]
2145
+ },
2146
+ "advancedOperationKey": {
2147
+ "description": "Advanced operation key",
2148
+ "type": "string",
2149
+ "enum": ["advancedCalculation", "nestedCalculation"]
2150
+ },
2151
+ "enabled": {
2152
+ "type": "boolean"
2153
+ }
2154
+ },
2155
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "enabled"],
2156
+ "additionalProperties": false
2157
+ }
2158
+ ```
2159
+
2160
+ ## `setMeasureAdvancedRangesComparisonFirstRangeEnd`
2161
+
2162
+ Advanced ranges first range end
2163
+
2164
+ Set first range end for ranges comparison
2165
+
2166
+ **Payload schema**
2167
+
2168
+ ```json
2169
+ {
2170
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2171
+ "title": "Measure advanced ranges first range end schema",
2172
+ "type": "object",
2173
+ "properties": {
2174
+ "dataItemInternalKey": {
2175
+ "description": "Internal key of the data item of the measure to be updated",
2176
+ "type": "string"
2177
+ },
2178
+ "dataItemUniqueSignature": {
2179
+ "description": "Unique signature of the data item of the measure to be updated",
2180
+ "type": "string"
2181
+ },
2182
+ "collectionKey": {
2183
+ "description": "Measure collection key",
2184
+ "type": "string",
2185
+ "enum": ["measures", "supportingMeasures"]
2186
+ },
2187
+ "advancedOperationKey": {
2188
+ "description": "Advanced operation key",
2189
+ "type": "string",
2190
+ "enum": ["advancedCalculation", "nestedCalculation"]
2191
+ },
2192
+ "firstRangeEnd": {
2193
+ "anyOf": [
2194
+ {
2195
+ "type": "number"
2196
+ },
2197
+ {
2198
+ "type": "object",
2199
+ "properties": {
2200
+ "type": {
2201
+ "type": "string",
2202
+ "const": "variable"
2203
+ },
2204
+ "variableName": {
2205
+ "type": "string"
2206
+ }
2207
+ },
2208
+ "required": ["type", "variableName"],
2209
+ "additionalProperties": false
2210
+ }
2211
+ ]
2212
+ }
2213
+ },
2214
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "firstRangeEnd"],
2215
+ "additionalProperties": false
2216
+ }
2217
+ ```
2218
+
2219
+ ## `setMeasureAdvancedRangesComparisonFirstRangeStart`
2220
+
2221
+ Advanced ranges first range start
2222
+
2223
+ Set first range start for ranges comparison
2224
+
2225
+ **Payload schema**
2226
+
2227
+ ```json
2228
+ {
2229
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2230
+ "title": "Measure advanced ranges first range start schema",
2231
+ "type": "object",
2232
+ "properties": {
2233
+ "dataItemInternalKey": {
2234
+ "description": "Internal key of the data item of the measure to be updated",
2235
+ "type": "string"
2236
+ },
2237
+ "dataItemUniqueSignature": {
2238
+ "description": "Unique signature of the data item of the measure to be updated",
2239
+ "type": "string"
2240
+ },
2241
+ "collectionKey": {
2242
+ "description": "Measure collection key",
2243
+ "type": "string",
2244
+ "enum": ["measures", "supportingMeasures"]
2245
+ },
2246
+ "advancedOperationKey": {
2247
+ "description": "Advanced operation key",
2248
+ "type": "string",
2249
+ "enum": ["advancedCalculation", "nestedCalculation"]
2250
+ },
2251
+ "firstRangeStart": {
2252
+ "anyOf": [
2253
+ {
2254
+ "type": "number"
2255
+ },
2256
+ {
2257
+ "type": "object",
2258
+ "properties": {
2259
+ "type": {
2260
+ "type": "string",
2261
+ "const": "variable"
2262
+ },
2263
+ "variableName": {
2264
+ "type": "string"
2265
+ }
2266
+ },
2267
+ "required": ["type", "variableName"],
2268
+ "additionalProperties": false
2269
+ }
2270
+ ]
2271
+ }
2272
+ },
2273
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "firstRangeStart"],
2274
+ "additionalProperties": false
2275
+ }
2276
+ ```
2277
+
2278
+ ## `setMeasureAdvancedRangesComparisonSecondRangeEnd`
2279
+
2280
+ Advanced ranges second range end
2281
+
2282
+ Set second range end for ranges comparison
2283
+
2284
+ **Payload schema**
2285
+
2286
+ ```json
2287
+ {
2288
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2289
+ "title": "Measure advanced ranges second range end schema",
2290
+ "type": "object",
2291
+ "properties": {
2292
+ "dataItemInternalKey": {
2293
+ "description": "Internal key of the data item of the measure to be updated",
2294
+ "type": "string"
2295
+ },
2296
+ "dataItemUniqueSignature": {
2297
+ "description": "Unique signature of the data item of the measure to be updated",
2298
+ "type": "string"
2299
+ },
2300
+ "collectionKey": {
2301
+ "description": "Measure collection key",
2302
+ "type": "string",
2303
+ "enum": ["measures", "supportingMeasures"]
2304
+ },
2305
+ "advancedOperationKey": {
2306
+ "description": "Advanced operation key",
2307
+ "type": "string",
2308
+ "enum": ["advancedCalculation", "nestedCalculation"]
2309
+ },
2310
+ "secondRangeEnd": {
2311
+ "anyOf": [
2312
+ {
2313
+ "type": "number"
2314
+ },
2315
+ {
2316
+ "type": "object",
2317
+ "properties": {
2318
+ "type": {
2319
+ "type": "string",
2320
+ "const": "variable"
2321
+ },
2322
+ "variableName": {
2323
+ "type": "string"
2324
+ }
2325
+ },
2326
+ "required": ["type", "variableName"],
2327
+ "additionalProperties": false
2328
+ }
2329
+ ]
2330
+ }
2331
+ },
2332
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "secondRangeEnd"],
2333
+ "additionalProperties": false
2334
+ }
2335
+ ```
2336
+
2337
+ ## `setMeasureAdvancedRangesComparisonSecondRangeStart`
2338
+
2339
+ Advanced ranges second range start
2340
+
2341
+ Set second range start for ranges comparison
2342
+
2343
+ **Payload schema**
2344
+
2345
+ ```json
2346
+ {
2347
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2348
+ "title": "Measure advanced ranges second range start schema",
2349
+ "type": "object",
2350
+ "properties": {
2351
+ "dataItemInternalKey": {
2352
+ "description": "Internal key of the data item of the measure to be updated",
2353
+ "type": "string"
2354
+ },
2355
+ "dataItemUniqueSignature": {
2356
+ "description": "Unique signature of the data item of the measure to be updated",
2357
+ "type": "string"
2358
+ },
2359
+ "collectionKey": {
2360
+ "description": "Measure collection key",
2361
+ "type": "string",
2362
+ "enum": ["measures", "supportingMeasures"]
2363
+ },
2364
+ "advancedOperationKey": {
2365
+ "description": "Advanced operation key",
2366
+ "type": "string",
2367
+ "enum": ["advancedCalculation", "nestedCalculation"]
2368
+ },
2369
+ "secondRangeStart": {
2370
+ "anyOf": [
2371
+ {
2372
+ "type": "number"
2373
+ },
2374
+ {
2375
+ "type": "object",
2376
+ "properties": {
2377
+ "type": {
2378
+ "type": "string",
2379
+ "const": "variable"
2380
+ },
2381
+ "variableName": {
2382
+ "type": "string"
2383
+ }
2384
+ },
2385
+ "required": ["type", "variableName"],
2386
+ "additionalProperties": false
2387
+ }
2388
+ ]
2389
+ }
2390
+ },
2391
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "secondRangeStart"],
2392
+ "additionalProperties": false
2393
+ }
2394
+ ```
2395
+
2396
+ ## `setMeasureAdvancedRangesComparisonType`
2397
+
2398
+ Advanced ranges comparison type
2399
+
2400
+ Set ranges comparison type
2401
+
2402
+ **Payload schema**
2403
+
2404
+ ```json
2405
+ {
2406
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2407
+ "title": "Measure advanced ranges comparison type schema",
2408
+ "type": "object",
2409
+ "properties": {
2410
+ "dataItemInternalKey": {
2411
+ "description": "Internal key of the data item of the measure to be updated",
2412
+ "type": "string"
2413
+ },
2414
+ "dataItemUniqueSignature": {
2415
+ "description": "Unique signature of the data item of the measure to be updated",
2416
+ "type": "string"
2417
+ },
2418
+ "collectionKey": {
2419
+ "description": "Measure collection key",
2420
+ "type": "string",
2421
+ "enum": ["measures", "supportingMeasures"]
2422
+ },
2423
+ "advancedOperationKey": {
2424
+ "description": "Advanced operation key",
2425
+ "type": "string",
2426
+ "enum": ["advancedCalculation", "nestedCalculation"]
2427
+ },
2428
+ "type": {
2429
+ "type": "string",
2430
+ "enum": ["absolute", "percentage"]
2431
+ }
2432
+ },
2433
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "type"],
2434
+ "additionalProperties": false
2435
+ }
2436
+ ```
2437
+
2438
+ ## `setMeasureAdvancedRankSortDirection`
2439
+
2440
+ Advanced rank sort direction
2441
+
2442
+ Set rank sort direction for rank advanced calculation
2443
+
2444
+ **Payload schema**
2445
+
2446
+ ```json
2447
+ {
2448
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2449
+ "title": "Measure advanced rank sort direction schema",
2450
+ "type": "object",
2451
+ "properties": {
2452
+ "dataItemInternalKey": {
2453
+ "description": "Internal key of the data item of the measure to be updated",
2454
+ "type": "string"
2455
+ },
2456
+ "dataItemUniqueSignature": {
2457
+ "description": "Unique signature of the data item of the measure to be updated",
2458
+ "type": "string"
2459
+ },
2460
+ "collectionKey": {
2461
+ "description": "Measure collection key",
2462
+ "type": "string",
2463
+ "enum": ["measures", "supportingMeasures"]
2464
+ },
2465
+ "advancedOperationKey": {
2466
+ "description": "Advanced operation key",
2467
+ "type": "string",
2468
+ "enum": ["advancedCalculation", "nestedCalculation"]
2469
+ },
2470
+ "rankSortDirection": {
2471
+ "type": "string",
2472
+ "enum": ["asc", "desc"]
2473
+ }
2474
+ },
2475
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "rankSortDirection"],
2476
+ "additionalProperties": false
2477
+ }
2478
+ ```
2479
+
2480
+ ## `setMeasureAdvancedSortingOrder`
2481
+
2482
+ Advanced sorting order
2483
+
2484
+ Set sorting order used by advanced calculation
2485
+
2486
+ **Payload schema**
2487
+
2488
+ ```json
2489
+ {
2490
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2491
+ "title": "Measure advanced sorting order schema",
2492
+ "type": "object",
2493
+ "properties": {
2494
+ "dataItemInternalKey": {
2495
+ "description": "Internal key of the data item of the measure to be updated",
2496
+ "type": "string"
2497
+ },
2498
+ "dataItemUniqueSignature": {
2499
+ "description": "Unique signature of the data item of the measure to be updated",
2500
+ "type": "string"
2501
+ },
2502
+ "collectionKey": {
2503
+ "description": "Measure collection key",
2504
+ "type": "string",
2505
+ "enum": ["measures", "supportingMeasures"]
2506
+ },
2507
+ "advancedOperationKey": {
2508
+ "description": "Advanced operation key",
2509
+ "type": "string",
2510
+ "enum": ["advancedCalculation", "nestedCalculation"]
2511
+ },
2512
+ "sortingOrder": {
2513
+ "type": "array",
2514
+ "items": {
2515
+ "type": "object",
2516
+ "properties": {
2517
+ "id": {
2518
+ "type": "string"
2519
+ },
2520
+ "sortDirection": {
2521
+ "type": "string",
2522
+ "enum": ["asc", "desc"]
2523
+ }
2524
+ },
2525
+ "required": ["id", "sortDirection"],
2526
+ "additionalProperties": false
2527
+ }
2528
+ }
2529
+ },
2530
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "sortingOrder"],
2531
+ "additionalProperties": false
2532
+ }
2533
+ ```
2534
+
2535
+ ## `setMeasureAdvancedStandardDeviations`
2536
+
2537
+ Advanced standard deviations
2538
+
2539
+ Set standard deviations for outliers aggregation
2540
+
2541
+ **Payload schema**
2542
+
2543
+ ```json
2544
+ {
2545
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2546
+ "title": "Measure advanced standard deviations schema",
2547
+ "type": "object",
2548
+ "properties": {
2549
+ "dataItemInternalKey": {
2550
+ "description": "Internal key of the data item of the measure to be updated",
2551
+ "type": "string"
2552
+ },
2553
+ "dataItemUniqueSignature": {
2554
+ "description": "Unique signature of the data item of the measure to be updated",
2555
+ "type": "string"
2556
+ },
2557
+ "collectionKey": {
2558
+ "description": "Measure collection key",
2559
+ "type": "string",
2560
+ "enum": ["measures", "supportingMeasures"]
2561
+ },
2562
+ "advancedOperationKey": {
2563
+ "description": "Advanced operation key",
2564
+ "type": "string",
2565
+ "enum": ["advancedCalculation", "nestedCalculation"]
2566
+ },
2567
+ "standardDeviations": {
2568
+ "anyOf": [
2569
+ {
2570
+ "type": "number"
2571
+ },
2572
+ {
2573
+ "type": "object",
2574
+ "properties": {
2575
+ "type": {
2576
+ "type": "string",
2577
+ "const": "variable"
2578
+ },
2579
+ "variableName": {
2580
+ "type": "string"
2581
+ }
2582
+ },
2583
+ "required": ["type", "variableName"],
2584
+ "additionalProperties": false
2585
+ }
2586
+ ]
2587
+ }
2588
+ },
2589
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "standardDeviations"],
2590
+ "additionalProperties": false
2591
+ }
2592
+ ```
2593
+
2594
+ ## `setMeasureAdvancedWindowBegin`
2595
+
2596
+ Advanced periods before
2597
+
2598
+ Set periods before for moving calculation
2599
+
2600
+ **Payload schema**
2601
+
2602
+ ```json
2603
+ {
2604
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2605
+ "title": "Measure advanced window begin schema",
2606
+ "type": "object",
2607
+ "properties": {
2608
+ "dataItemInternalKey": {
2609
+ "description": "Internal key of the data item of the measure to be updated",
2610
+ "type": "string"
2611
+ },
2612
+ "dataItemUniqueSignature": {
2613
+ "description": "Unique signature of the data item of the measure to be updated",
2614
+ "type": "string"
2615
+ },
2616
+ "collectionKey": {
2617
+ "description": "Measure collection key",
2618
+ "type": "string",
2619
+ "enum": ["measures", "supportingMeasures"]
2620
+ },
2621
+ "advancedOperationKey": {
2622
+ "description": "Advanced operation key",
2623
+ "type": "string",
2624
+ "enum": ["advancedCalculation", "nestedCalculation"]
2625
+ },
2626
+ "windowBegin": {
2627
+ "anyOf": [
2628
+ {
2629
+ "type": "number"
2630
+ },
2631
+ {
2632
+ "type": "object",
2633
+ "properties": {
2634
+ "type": {
2635
+ "type": "string",
2636
+ "const": "variable"
2637
+ },
2638
+ "variableName": {
2639
+ "type": "string"
2640
+ }
2641
+ },
2642
+ "required": ["type", "variableName"],
2643
+ "additionalProperties": false
2644
+ }
2645
+ ]
2646
+ }
2647
+ },
2648
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "windowBegin"],
2649
+ "additionalProperties": false
2650
+ }
2651
+ ```
2652
+
2653
+ ## `setMeasureAdvancedWindowEnd`
2654
+
2655
+ Advanced periods after
2656
+
2657
+ Set periods after for moving calculation
2658
+
2659
+ **Payload schema**
2660
+
2661
+ ```json
2662
+ {
2663
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2664
+ "title": "Measure advanced window end schema",
2665
+ "type": "object",
2666
+ "properties": {
2667
+ "dataItemInternalKey": {
2668
+ "description": "Internal key of the data item of the measure to be updated",
2669
+ "type": "string"
2670
+ },
2671
+ "dataItemUniqueSignature": {
2672
+ "description": "Unique signature of the data item of the measure to be updated",
2673
+ "type": "string"
2674
+ },
2675
+ "collectionKey": {
2676
+ "description": "Measure collection key",
2677
+ "type": "string",
2678
+ "enum": ["measures", "supportingMeasures"]
2679
+ },
2680
+ "advancedOperationKey": {
2681
+ "description": "Advanced operation key",
2682
+ "type": "string",
2683
+ "enum": ["advancedCalculation", "nestedCalculation"]
2684
+ },
2685
+ "windowEnd": {
2686
+ "anyOf": [
2687
+ {
2688
+ "type": "number"
2689
+ },
2690
+ {
2691
+ "type": "object",
2692
+ "properties": {
2693
+ "type": {
2694
+ "type": "string",
2695
+ "const": "variable"
2696
+ },
2697
+ "variableName": {
2698
+ "type": "string"
2699
+ }
2700
+ },
2701
+ "required": ["type", "variableName"],
2702
+ "additionalProperties": false
2703
+ }
2704
+ ]
2705
+ }
2706
+ },
2707
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "windowEnd"],
2708
+ "additionalProperties": false
2709
+ }
2710
+ ```
2711
+
2712
+ ## `setMeasureCurrency`
2713
+
2714
+ Measure currency
2715
+
2716
+ Set the currency symbol used by a measure formatter
2717
+
2718
+ **Payload schema**
2719
+
2720
+ ```json
2721
+ {
2722
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2723
+ "title": "Measure currency schema",
2724
+ "type": "object",
2725
+ "properties": {
2726
+ "dataItemInternalKey": {
2727
+ "description": "Internal key of the data item of the measure to be updated",
2728
+ "type": "string"
2729
+ },
2730
+ "dataItemUniqueSignature": {
2731
+ "description": "Unique signature of the data item of the measure to be updated",
2732
+ "type": "string"
2733
+ },
2734
+ "currency": {
2735
+ "type": "string"
2736
+ }
2737
+ },
2738
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
2739
+ "additionalProperties": false
2740
+ }
2741
+ ```
2742
+
2743
+ ## `setMeasureCurrencyIsPrefix`
2744
+
2745
+ Measure currency is prefix
2746
+
2747
+ Set whether measure currency symbol is prefixed
2748
+
2749
+ **Payload schema**
2750
+
2751
+ ```json
2752
+ {
2753
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2754
+ "title": "Measure currency is prefix schema",
2755
+ "type": "object",
2756
+ "properties": {
2757
+ "dataItemInternalKey": {
2758
+ "description": "Internal key of the data item of the measure to be updated",
2759
+ "type": "string"
2760
+ },
2761
+ "dataItemUniqueSignature": {
2762
+ "description": "Unique signature of the data item of the measure to be updated",
2763
+ "type": "string"
2764
+ },
2765
+ "currencyIsPrefix": {
2766
+ "type": "boolean"
2767
+ }
2768
+ },
2769
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
2770
+ "additionalProperties": false
2771
+ }
2772
+ ```
2773
+
2774
+ ## `setMeasureDefinedParameter`
2775
+
2776
+ Measure defined parameter
2777
+
2778
+ Configure a Defined parameter of a custom measure using its default, a static value, or an existing compatible workbook variable
2779
+
2780
+ **Payload schema**
2781
+
2782
+ ```json
2783
+ {
2784
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2785
+ "title": "Set measure defined parameter schema",
2786
+ "type": "object",
2787
+ "properties": {
2788
+ "dataItemInternalKey": {
2789
+ "description": "Internal key of the data item of the measure to be updated",
2790
+ "type": "string"
2791
+ },
2792
+ "dataItemUniqueSignature": {
2793
+ "description": "Unique signature of the data item of the measure to be updated",
2794
+ "type": "string"
2795
+ },
2796
+ "collectionKey": {
2797
+ "description": "Measure collection to update. Defaults to primary measures.",
2798
+ "type": "string",
2799
+ "enum": ["measures", "supportingMeasures"]
2800
+ },
2801
+ "parameterName": {
2802
+ "description": "Exact name of a Defined parameter exposed by the measure",
2803
+ "type": "string",
2804
+ "minLength": 1
2805
+ },
2806
+ "value": {
2807
+ "description": "Use default to remove the override, static for a literal value, or variable to bind a workbook variable",
2808
+ "anyOf": [
2809
+ {
2810
+ "type": "object",
2811
+ "properties": {
2812
+ "type": {
2813
+ "type": "string",
2814
+ "const": "default"
2815
+ }
2816
+ },
2817
+ "required": ["type"],
2818
+ "additionalProperties": false
2819
+ },
2820
+ {
2821
+ "type": "object",
2822
+ "properties": {
2823
+ "type": {
2824
+ "type": "string",
2825
+ "const": "static"
2826
+ },
2827
+ "value": {
2828
+ "anyOf": [
2829
+ {
2830
+ "type": "string"
2831
+ },
2832
+ {
2833
+ "type": "number"
2834
+ },
2835
+ {
2836
+ "type": "boolean"
2837
+ }
2838
+ ]
2839
+ }
2840
+ },
2841
+ "required": ["type", "value"],
2842
+ "additionalProperties": false
2843
+ },
2844
+ {
2845
+ "type": "object",
2846
+ "properties": {
2847
+ "type": {
2848
+ "type": "string",
2849
+ "const": "variable"
2850
+ },
2851
+ "variableName": {
2852
+ "description": "Exact name of an existing compatible workbook variable",
2853
+ "type": "string",
2854
+ "minLength": 1
2855
+ }
2856
+ },
2857
+ "required": ["type", "variableName"],
2858
+ "additionalProperties": false
2859
+ }
2860
+ ]
2861
+ }
2862
+ },
2863
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "parameterName", "value"],
2864
+ "additionalProperties": false
2865
+ }
2866
+ ```
2867
+
2868
+ ## `setMeasureFilter`
2869
+
2870
+ Set measure filter
2871
+
2872
+ Set one measure filter before aggregation. Adds if none, replaces if one, fails if multiple.
2873
+
2874
+ **Payload schema**
2875
+
2876
+ ```json
2877
+ {
2878
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2879
+ "description": "Set one measure filter before aggregation. Adds if none, replaces if one, fails if multiple.",
2880
+ "title": "Set measure filter schema",
2881
+ "anyOf": [
2882
+ {
2883
+ "type": "object",
2884
+ "properties": {
2885
+ "measureName": {
2886
+ "description": "Visible measure name or label",
2887
+ "type": "string"
2888
+ },
2889
+ "fieldKey": {
2890
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
2891
+ "type": "string"
2892
+ },
2893
+ "operator": {
2894
+ "description": "Filter operator that requires a value",
2895
+ "type": "string",
2896
+ "enum": [
2897
+ "equals",
2898
+ "doesNotEqual",
2899
+ "greaterThan",
2900
+ "lessThan",
2901
+ "greaterThanOrEqualTo",
2902
+ "lessThanOrEqualTo",
2903
+ "contains",
2904
+ "excludes",
2905
+ "like",
2906
+ "notLike",
2907
+ "startsWith",
2908
+ "endsWith"
2909
+ ]
2910
+ },
2911
+ "value": {
2912
+ "description": "Filter value",
2913
+ "anyOf": [
2914
+ {
2915
+ "type": "string"
2916
+ },
2917
+ {
2918
+ "type": "object",
2919
+ "properties": {
2920
+ "type": {
2921
+ "type": "string",
2922
+ "const": "variable"
2923
+ },
2924
+ "variableName": {
2925
+ "type": "string"
2926
+ }
2927
+ },
2928
+ "required": ["type", "variableName"],
2929
+ "additionalProperties": false
2930
+ }
2931
+ ]
2932
+ }
2933
+ },
2934
+ "required": ["measureName", "fieldKey", "operator", "value"],
2935
+ "additionalProperties": false
2936
+ },
2937
+ {
2938
+ "type": "object",
2939
+ "properties": {
2940
+ "measureName": {
2941
+ "description": "Visible measure name or label",
2942
+ "type": "string"
2943
+ },
2944
+ "fieldKey": {
2945
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
2946
+ "type": "string"
2947
+ },
2948
+ "operator": {
2949
+ "description": "Filter operator that requires valueFrom and valueTo",
2950
+ "type": "string",
2951
+ "enum": ["isBetween", "isNotBetween"]
2952
+ },
2953
+ "valueFrom": {
2954
+ "description": "Lower filter value",
2955
+ "anyOf": [
2956
+ {
2957
+ "type": "string"
2958
+ },
2959
+ {
2960
+ "type": "object",
2961
+ "properties": {
2962
+ "type": {
2963
+ "type": "string",
2964
+ "const": "variable"
2965
+ },
2966
+ "variableName": {
2967
+ "type": "string"
2968
+ }
2969
+ },
2970
+ "required": ["type", "variableName"],
2971
+ "additionalProperties": false
2972
+ }
2973
+ ]
2974
+ },
2975
+ "valueTo": {
2976
+ "description": "Upper filter value",
2977
+ "anyOf": [
2978
+ {
2979
+ "type": "string"
2980
+ },
2981
+ {
2982
+ "type": "object",
2983
+ "properties": {
2984
+ "type": {
2985
+ "type": "string",
2986
+ "const": "variable"
2987
+ },
2988
+ "variableName": {
2989
+ "type": "string"
2990
+ }
2991
+ },
2992
+ "required": ["type", "variableName"],
2993
+ "additionalProperties": false
2994
+ }
2995
+ ]
2996
+ }
2997
+ },
2998
+ "required": ["measureName", "fieldKey", "operator", "valueFrom", "valueTo"],
2999
+ "additionalProperties": false
3000
+ },
3001
+ {
3002
+ "type": "object",
3003
+ "properties": {
3004
+ "measureName": {
3005
+ "description": "Visible measure name or label",
3006
+ "type": "string"
3007
+ },
3008
+ "fieldKey": {
3009
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
3010
+ "type": "string"
3011
+ },
3012
+ "operator": {
3013
+ "description": "Filter operator that requires a list of values",
3014
+ "type": "string",
3015
+ "enum": ["inList", "excludedFromList"]
3016
+ },
3017
+ "values": {
3018
+ "description": "Filter values",
3019
+ "minItems": 1,
3020
+ "type": "array",
3021
+ "items": {
3022
+ "type": "string"
3023
+ }
3024
+ }
3025
+ },
3026
+ "required": ["measureName", "fieldKey", "operator", "values"],
3027
+ "additionalProperties": false
3028
+ },
3029
+ {
3030
+ "type": "object",
3031
+ "properties": {
3032
+ "measureName": {
3033
+ "description": "Visible measure name or label",
3034
+ "type": "string"
3035
+ },
3036
+ "fieldKey": {
3037
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
3038
+ "type": "string"
3039
+ },
3040
+ "operator": {
3041
+ "description": "Filter operator that does not require values",
3042
+ "type": "string",
3043
+ "enum": ["isNull", "notNull"]
3044
+ }
3045
+ },
3046
+ "required": ["measureName", "fieldKey", "operator"],
3047
+ "additionalProperties": false
3048
+ }
3049
+ ]
3050
+ }
3051
+ ```
3052
+
3053
+ ## `setMeasureFormatString`
3054
+
3055
+ Measure format string
3056
+
3057
+ Set the custom format string for a measure
3058
+
3059
+ **Payload schema**
3060
+
3061
+ ```json
3062
+ {
3063
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3064
+ "title": "Measure format string schema",
3065
+ "type": "object",
3066
+ "properties": {
3067
+ "dataItemInternalKey": {
3068
+ "description": "Internal key of the data item of the measure to be updated",
3069
+ "type": "string"
3070
+ },
3071
+ "dataItemUniqueSignature": {
3072
+ "description": "Unique signature of the data item of the measure to be updated",
3073
+ "type": "string"
3074
+ },
3075
+ "formatString": {
3076
+ "anyOf": [
3077
+ {
3078
+ "type": "string"
3079
+ },
3080
+ {
3081
+ "type": "object",
3082
+ "properties": {
3083
+ "type": {
3084
+ "type": "string",
3085
+ "const": "variable"
3086
+ },
3087
+ "variableName": {
3088
+ "type": "string"
3089
+ }
3090
+ },
3091
+ "required": ["type", "variableName"],
3092
+ "additionalProperties": false
3093
+ }
3094
+ ]
3095
+ }
3096
+ },
3097
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
3098
+ "additionalProperties": false
3099
+ }
3100
+ ```
3101
+
3102
+ ## `setMeasureFormatType`
3103
+
3104
+ Measure format type
3105
+
3106
+ Set the format type used by a measure
3107
+
3108
+ **Payload schema**
3109
+
3110
+ ```json
3111
+ {
3112
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3113
+ "title": "Measure format type schema",
3114
+ "type": "object",
3115
+ "properties": {
3116
+ "dataItemInternalKey": {
3117
+ "description": "Internal key of the data item of the measure to be updated",
3118
+ "type": "string"
3119
+ },
3120
+ "dataItemUniqueSignature": {
3121
+ "description": "Unique signature of the data item of the measure to be updated",
3122
+ "type": "string"
3123
+ },
3124
+ "formatType": {
3125
+ "anyOf": [
3126
+ {
3127
+ "type": "string",
3128
+ "enum": [
3129
+ "custom",
3130
+ "inherit",
3131
+ "none",
3132
+ "defaultNumber",
3133
+ "defaultMoney",
3134
+ "numberNoDecimal",
3135
+ "number1Decimal",
3136
+ "number2Decimal",
3137
+ "abbreviationAuto",
3138
+ "abbreviationNoDecimal",
3139
+ "abbreviation1Decimal",
3140
+ "abbreviation2Decimal",
3141
+ "percentageNoDecimal",
3142
+ "percentage1Decimal",
3143
+ "percentage2Decimal",
3144
+ "money0Decimal",
3145
+ "money2Decimal",
3146
+ "durationDays",
3147
+ "durationHours",
3148
+ "durationMinutes",
3149
+ "durationSeconds"
3150
+ ]
3151
+ },
3152
+ {
3153
+ "type": "string",
3154
+ "enum": [
3155
+ "defaultDate",
3156
+ "defaultDatetime",
3157
+ "defaultTime",
3158
+ "ddmmyyyy",
3159
+ "ddmmyyyy2",
3160
+ "ddmmyyyy3",
3161
+ "yyyymmdd",
3162
+ "mmddyyyy",
3163
+ "mmddyyyy2",
3164
+ "ddmmmmyyyy",
3165
+ "ddmmmyyyy",
3166
+ "ddmmmyy",
3167
+ "mmmmddyyyy",
3168
+ "yyyy",
3169
+ "yy",
3170
+ "mmmyyyy",
3171
+ "yyyymmm",
3172
+ "yyyymmmm",
3173
+ "mmyyyy",
3174
+ "yyyymm",
3175
+ "mmmmyyyy",
3176
+ "yyyywn",
3177
+ "wnyyyy",
3178
+ "yywn",
3179
+ "yyyyq",
3180
+ "qyyyy",
3181
+ "yyyymmddhhmmss",
3182
+ "yyyymmddhmmss",
3183
+ "yyyymmddhhmm",
3184
+ "yyyymmddhh",
3185
+ "yyyymmddhmm",
3186
+ "yyyymmddh",
3187
+ "ddmmmyyyyhhmmss",
3188
+ "ddmmmyyyyhmmss",
3189
+ "ddmmmyyyyhhmm",
3190
+ "ddmmmyyyyhmm",
3191
+ "ddmmmyyyyh",
3192
+ "hhmmss",
3193
+ "hhmm",
3194
+ "hmm",
3195
+ "h",
3196
+ "hh",
3197
+ "hmmss",
3198
+ "month",
3199
+ "month2",
3200
+ "monthn",
3201
+ "month3",
3202
+ "quarter",
3203
+ "quarter2",
3204
+ "week1",
3205
+ "week2",
3206
+ "week3",
3207
+ "day",
3208
+ "dayOfWeek",
3209
+ "hhn",
3210
+ "hn"
3211
+ ]
3212
+ }
3213
+ ]
3214
+ }
3215
+ },
3216
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "formatType"],
3217
+ "additionalProperties": false
3218
+ }
3219
+ ```
3220
+
3221
+ ## `setMeasureNegativeType`
3222
+
3223
+ Measure negative type
3224
+
3225
+ Set how negative values are displayed for a measure formatter
3226
+
3227
+ **Payload schema**
3228
+
3229
+ ```json
3230
+ {
3231
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3232
+ "title": "Measure negative type schema",
3233
+ "type": "object",
3234
+ "properties": {
3235
+ "dataItemInternalKey": {
3236
+ "description": "Internal key of the data item of the measure to be updated",
3237
+ "type": "string"
3238
+ },
3239
+ "dataItemUniqueSignature": {
3240
+ "description": "Unique signature of the data item of the measure to be updated",
3241
+ "type": "string"
3242
+ },
3243
+ "negativeType": {
3244
+ "type": "string",
3245
+ "enum": ["symbol", "parenthesis"]
3246
+ }
3247
+ },
3248
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
3249
+ "additionalProperties": false
3250
+ }
3251
+ ```
3252
+
3253
+ ## `setNumberFontColor`
3254
+
3255
+ Number font color
3256
+
3257
+ Change the color of the main number display
3258
+
3259
+ **Payload schema**
3260
+
3261
+ ```json
3262
+ {
3263
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3264
+ "description": "Font color (hex, with optional alpha)",
3265
+ "title": "Number font color schema",
3266
+ "anyOf": [
3267
+ {
3268
+ "type": "string",
3269
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
3270
+ },
3271
+ {
3272
+ "type": "null"
3273
+ }
3274
+ ]
3275
+ }
3276
+ ```
3277
+
3278
+ ## `setNumberFontFamily`
3279
+
3280
+ Number font family
3281
+
3282
+ Change the font family for the main number display
3283
+
3284
+ **Payload schema**
3285
+
3286
+ ```json
3287
+ {
3288
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3289
+ "title": "Number font family schema",
3290
+ "anyOf": [
3291
+ {
3292
+ "type": "string"
3293
+ },
3294
+ {
3295
+ "type": "null"
3296
+ }
3297
+ ]
3298
+ }
3299
+ ```
3300
+
3301
+ ## `setNumberFontSize`
3302
+
3303
+ Number font size
3304
+
3305
+ Adjust the font size of the main number display
3306
+
3307
+ **Payload schema**
3308
+
3309
+ ```json
3310
+ {
3311
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3312
+ "title": "Number font size schema",
3313
+ "type": "number"
3314
+ }
3315
+ ```
3316
+
3317
+ ## `setNumberFontStyle`
3318
+
3319
+ Number font style
3320
+
3321
+ Apply font styling to the main number
3322
+
3323
+ **Payload schema**
3324
+
3325
+ ```json
3326
+ {
3327
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3328
+ "title": "Number font style schema",
3329
+ "type": "object",
3330
+ "properties": {
3331
+ "weight": {
3332
+ "description": "Font weight",
3333
+ "anyOf": [
3334
+ {
3335
+ "type": "number"
3336
+ },
3337
+ {
3338
+ "type": "null"
3339
+ }
3340
+ ]
3341
+ },
3342
+ "bold": {
3343
+ "description": "Bold font. Should take precedence over weight",
3344
+ "type": "boolean"
3345
+ },
3346
+ "italic": {
3347
+ "type": "boolean"
3348
+ },
3349
+ "underlined": {
3350
+ "type": "boolean"
3351
+ },
3352
+ "strikethrough": {
3353
+ "type": "boolean"
3354
+ },
3355
+ "fontFamily": {
3356
+ "anyOf": [
3357
+ {
3358
+ "type": "string"
3359
+ },
3360
+ {
3361
+ "type": "null"
3362
+ }
3363
+ ]
3364
+ },
3365
+ "fontSize": {
3366
+ "type": "number"
3367
+ },
3368
+ "fontColor": {
3369
+ "description": "Font color (hex, with optional alpha)",
3370
+ "anyOf": [
3371
+ {
3372
+ "type": "string",
3373
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
3374
+ },
3375
+ {
3376
+ "type": "null"
3377
+ }
3378
+ ]
3379
+ }
3380
+ },
3381
+ "additionalProperties": false
3382
+ }
3383
+ ```
3384
+
3385
+ ## `setNumberFontWeight`
3386
+
3387
+ Number font weight
3388
+
3389
+ Set the font weight of the main number display
3390
+
3391
+ **Payload schema**
3392
+
3393
+ ```json
3394
+ {
3395
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3396
+ "description": "Font weight",
3397
+ "title": "Number font weight schema",
3398
+ "anyOf": [
3399
+ {
3400
+ "type": "number"
3401
+ },
3402
+ {
3403
+ "type": "null"
3404
+ }
3405
+ ]
3406
+ }
3407
+ ```
3408
+
3409
+ ## `setQueryTimeout`
3410
+
3411
+ Set query timeout
3412
+
3413
+ Set the timeout duration for database queries in seconds
3414
+
3415
+ **Payload schema**
3416
+
3417
+ ```json
3418
+ {
3419
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3420
+ "title": "Query timeout schema",
3421
+ "anyOf": [
3422
+ {
3423
+ "type": "number",
3424
+ "minimum": 120,
3425
+ "maximum": 600
3426
+ },
3427
+ {
3428
+ "type": "object",
3429
+ "properties": {
3430
+ "type": {
3431
+ "type": "string",
3432
+ "const": "variable"
3433
+ },
3434
+ "variableName": {
3435
+ "type": "string"
3436
+ }
3437
+ },
3438
+ "required": ["type", "variableName"],
3439
+ "additionalProperties": false
3440
+ }
3441
+ ]
3442
+ }
3443
+ ```
3444
+
3445
+ ## `setResultFilter`
3446
+
3447
+ Set result filter
3448
+
3449
+ Set one result filter after aggregation. Adds if none, replaces if one, fails if multiple.
3450
+
3451
+ **Payload schema**
3452
+
3453
+ ```json
3454
+ {
3455
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3456
+ "description": "Set one result filter after aggregation. Adds if none, replaces if one, fails if multiple.",
3457
+ "title": "Set result filter schema",
3458
+ "anyOf": [
3459
+ {
3460
+ "type": "object",
3461
+ "properties": {
3462
+ "measureName": {
3463
+ "description": "Visible measure name or label",
3464
+ "type": "string"
3465
+ },
3466
+ "operator": {
3467
+ "description": "Filter operator that requires a value",
3468
+ "type": "string",
3469
+ "enum": [
3470
+ "equals",
3471
+ "doesNotEqual",
3472
+ "greaterThan",
3473
+ "lessThan",
3474
+ "greaterThanOrEqualTo",
3475
+ "lessThanOrEqualTo",
3476
+ "contains",
3477
+ "excludes",
3478
+ "like",
3479
+ "notLike",
3480
+ "startsWith",
3481
+ "endsWith"
3482
+ ]
3483
+ },
3484
+ "value": {
3485
+ "description": "Filter value",
3486
+ "anyOf": [
3487
+ {
3488
+ "type": "string"
3489
+ },
3490
+ {
3491
+ "type": "object",
3492
+ "properties": {
3493
+ "type": {
3494
+ "type": "string",
3495
+ "const": "variable"
3496
+ },
3497
+ "variableName": {
3498
+ "type": "string"
3499
+ }
3500
+ },
3501
+ "required": ["type", "variableName"],
3502
+ "additionalProperties": false
3503
+ }
3504
+ ]
3505
+ }
3506
+ },
3507
+ "required": ["measureName", "operator", "value"],
3508
+ "additionalProperties": false
3509
+ },
3510
+ {
3511
+ "type": "object",
3512
+ "properties": {
3513
+ "measureName": {
3514
+ "description": "Visible measure name or label",
3515
+ "type": "string"
3516
+ },
3517
+ "operator": {
3518
+ "description": "Filter operator that requires valueFrom and valueTo",
3519
+ "type": "string",
3520
+ "enum": ["isBetween", "isNotBetween"]
3521
+ },
3522
+ "valueFrom": {
3523
+ "description": "Lower filter value",
3524
+ "anyOf": [
3525
+ {
3526
+ "type": "string"
3527
+ },
3528
+ {
3529
+ "type": "object",
3530
+ "properties": {
3531
+ "type": {
3532
+ "type": "string",
3533
+ "const": "variable"
3534
+ },
3535
+ "variableName": {
3536
+ "type": "string"
3537
+ }
3538
+ },
3539
+ "required": ["type", "variableName"],
3540
+ "additionalProperties": false
3541
+ }
3542
+ ]
3543
+ },
3544
+ "valueTo": {
3545
+ "description": "Upper filter value",
3546
+ "anyOf": [
3547
+ {
3548
+ "type": "string"
3549
+ },
3550
+ {
3551
+ "type": "object",
3552
+ "properties": {
3553
+ "type": {
3554
+ "type": "string",
3555
+ "const": "variable"
3556
+ },
3557
+ "variableName": {
3558
+ "type": "string"
3559
+ }
3560
+ },
3561
+ "required": ["type", "variableName"],
3562
+ "additionalProperties": false
3563
+ }
3564
+ ]
3565
+ }
3566
+ },
3567
+ "required": ["measureName", "operator", "valueFrom", "valueTo"],
3568
+ "additionalProperties": false
3569
+ },
3570
+ {
3571
+ "type": "object",
3572
+ "properties": {
3573
+ "measureName": {
3574
+ "description": "Visible measure name or label",
3575
+ "type": "string"
3576
+ },
3577
+ "operator": {
3578
+ "description": "Filter operator that requires a list of values",
3579
+ "type": "string",
3580
+ "enum": ["inList", "excludedFromList"]
3581
+ },
3582
+ "values": {
3583
+ "description": "Filter values",
3584
+ "minItems": 1,
3585
+ "type": "array",
3586
+ "items": {
3587
+ "type": "string"
3588
+ }
3589
+ }
3590
+ },
3591
+ "required": ["measureName", "operator", "values"],
3592
+ "additionalProperties": false
3593
+ },
3594
+ {
3595
+ "type": "object",
3596
+ "properties": {
3597
+ "measureName": {
3598
+ "description": "Visible measure name or label",
3599
+ "type": "string"
3600
+ },
3601
+ "operator": {
3602
+ "description": "Filter operator that does not require values",
3603
+ "type": "string",
3604
+ "enum": ["isNull", "notNull"]
3605
+ }
3606
+ },
3607
+ "required": ["measureName", "operator"],
3608
+ "additionalProperties": false
3609
+ }
3610
+ ]
3611
+ }
3612
+ ```
3613
+
3614
+ ## `setStaticFilterGroup`
3615
+
3616
+ Set static filter group
3617
+
3618
+ Replace all static filters with a nested AND/OR filter group.
3619
+
3620
+ **Payload schema**
3621
+
3622
+ ```json
3623
+ {
3624
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3625
+ "description": "Replace all static filters with this nested AND/OR filter group.",
3626
+ "title": "Set static filter group schema",
3627
+ "$ref": "#/$defs/__schema0",
3628
+ "$defs": {
3629
+ "__schema0": {
3630
+ "type": "object",
3631
+ "properties": {
3632
+ "operator": {
3633
+ "type": "string",
3634
+ "enum": ["and", "or"]
3635
+ },
3636
+ "filters": {
3637
+ "type": "array",
3638
+ "items": {
3639
+ "anyOf": [
3640
+ {
3641
+ "type": "object",
3642
+ "properties": {
3643
+ "fieldKey": {
3644
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
3645
+ "type": "string"
3646
+ },
3647
+ "operator": {
3648
+ "anyOf": [
3649
+ {
3650
+ "type": "string",
3651
+ "enum": [
3652
+ "equals",
3653
+ "doesNotEqual",
3654
+ "greaterThan",
3655
+ "lessThan",
3656
+ "greaterThanOrEqualTo",
3657
+ "lessThanOrEqualTo",
3658
+ "isBetween",
3659
+ "isNotBetween",
3660
+ "isNull",
3661
+ "notNull",
3662
+ "contains",
3663
+ "excludes",
3664
+ "like",
3665
+ "notLike",
3666
+ "startsWith",
3667
+ "endsWith",
3668
+ "predefined_date_range",
3669
+ "previous",
3670
+ "current",
3671
+ "before",
3672
+ "after",
3673
+ "inList",
3674
+ "excludedFromList",
3675
+ "divider"
3676
+ ]
3677
+ },
3678
+ {
3679
+ "type": "string",
3680
+ "enum": [
3681
+ "ytd",
3682
+ "mtd",
3683
+ "qtd",
3684
+ "wtd",
3685
+ "pytd",
3686
+ "pmtd",
3687
+ "pqtd",
3688
+ "pwtd",
3689
+ "l12m",
3690
+ "l90d",
3691
+ "l30d",
3692
+ "l7d",
3693
+ "cy",
3694
+ "cq",
3695
+ "cm",
3696
+ "py",
3697
+ "pm",
3698
+ "pq",
3699
+ "pw",
3700
+ "today",
3701
+ "yesterday",
3702
+ "mindate",
3703
+ "maxdate"
3704
+ ]
3705
+ }
3706
+ ]
3707
+ },
3708
+ "values": {
3709
+ "type": "object",
3710
+ "properties": {
3711
+ "value": {
3712
+ "anyOf": [
3713
+ {
3714
+ "type": "string"
3715
+ },
3716
+ {
3717
+ "type": "object",
3718
+ "properties": {
3719
+ "type": {
3720
+ "type": "string",
3721
+ "const": "variable"
3722
+ },
3723
+ "variableName": {
3724
+ "type": "string"
3725
+ }
3726
+ },
3727
+ "required": ["type", "variableName"],
3728
+ "additionalProperties": false
3729
+ }
3730
+ ]
3731
+ },
3732
+ "valueFrom": {
3733
+ "anyOf": [
3734
+ {
3735
+ "type": "string"
3736
+ },
3737
+ {
3738
+ "type": "object",
3739
+ "properties": {
3740
+ "type": {
3741
+ "type": "string",
3742
+ "const": "variable"
3743
+ },
3744
+ "variableName": {
3745
+ "type": "string"
3746
+ }
3747
+ },
3748
+ "required": ["type", "variableName"],
3749
+ "additionalProperties": false
3750
+ }
3751
+ ]
3752
+ },
3753
+ "valueTo": {
3754
+ "anyOf": [
3755
+ {
3756
+ "type": "string"
3757
+ },
3758
+ {
3759
+ "type": "object",
3760
+ "properties": {
3761
+ "type": {
3762
+ "type": "string",
3763
+ "const": "variable"
3764
+ },
3765
+ "variableName": {
3766
+ "type": "string"
3767
+ }
3768
+ },
3769
+ "required": ["type", "variableName"],
3770
+ "additionalProperties": false
3771
+ }
3772
+ ]
3773
+ },
3774
+ "secondValue": {
3775
+ "anyOf": [
3776
+ {
3777
+ "type": "string"
3778
+ },
3779
+ {
3780
+ "type": "object",
3781
+ "properties": {
3782
+ "type": {
3783
+ "type": "string",
3784
+ "const": "variable"
3785
+ },
3786
+ "variableName": {
3787
+ "type": "string"
3788
+ }
3789
+ },
3790
+ "required": ["type", "variableName"],
3791
+ "additionalProperties": false
3792
+ }
3793
+ ]
3794
+ }
3795
+ },
3796
+ "additionalProperties": false
3797
+ },
3798
+ "dateFilter": {
3799
+ "anyOf": [
3800
+ {
3801
+ "type": "string",
3802
+ "enum": [
3803
+ "ytd",
3804
+ "mtd",
3805
+ "qtd",
3806
+ "wtd",
3807
+ "pytd",
3808
+ "pmtd",
3809
+ "pqtd",
3810
+ "pwtd",
3811
+ "l12m",
3812
+ "l90d",
3813
+ "l30d",
3814
+ "l7d",
3815
+ "cy",
3816
+ "cq",
3817
+ "cm",
3818
+ "py",
3819
+ "pm",
3820
+ "pq",
3821
+ "pw",
3822
+ "today",
3823
+ "yesterday",
3824
+ "mindate",
3825
+ "maxdate"
3826
+ ]
3827
+ },
3828
+ {
3829
+ "type": "null"
3830
+ }
3831
+ ]
3832
+ }
3833
+ },
3834
+ "required": ["fieldKey", "operator", "values"],
3835
+ "additionalProperties": false
3836
+ },
3837
+ {
3838
+ "$ref": "#/$defs/__schema0"
3839
+ }
3840
+ ]
3841
+ }
3842
+ }
3843
+ },
3844
+ "required": ["operator", "filters"],
3845
+ "additionalProperties": false
3846
+ }
3847
+ }
3848
+ }
3849
+ ```
3850
+
3851
+ ## `setVerticalAlign`
3852
+
3853
+ Vertical align
3854
+
3855
+ Set vertical alignment of the number
3856
+
3857
+ **Payload schema**
3858
+
3859
+ ```json
3860
+ {
3861
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3862
+ "title": "Number vertical align schema",
3863
+ "type": "string",
3864
+ "enum": ["auto", "top", "middle", "bottom"]
3865
+ }
3866
+ ```
3867
+
3868
+ ## `toggleMeasure`
3869
+
3870
+ Toggle measure
3871
+
3872
+ Enable or disable a measure in the chart
3873
+
3874
+ **Payload schema**
3875
+
3876
+ ```json
3877
+ {
3878
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3879
+ "title": "Toggle measure schema",
3880
+ "type": "object",
3881
+ "properties": {
3882
+ "dataItemInternalKey": {
3883
+ "description": "Internal key of the data item of the measure to be toggled",
3884
+ "type": "string"
3885
+ },
3886
+ "dataItemUniqueSignature": {
3887
+ "description": "Unique signature of the data item of the measure to be toggled",
3888
+ "type": "string"
3889
+ }
3890
+ },
3891
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
3892
+ "additionalProperties": false
3893
+ }
3894
+ ```
3895
+
3896
+ ## `toggleMeasureByName`
3897
+
3898
+ Toggle measure by name
3899
+
3900
+ Enable, disable, or toggle a measure by its name
3901
+
3902
+ **Payload schema**
3903
+
3904
+ ```json
3905
+ {
3906
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3907
+ "title": "Toggle measure by name schema",
3908
+ "type": "object",
3909
+ "properties": {
3910
+ "name": {
3911
+ "type": "string"
3912
+ },
3913
+ "operation": {
3914
+ "type": "string",
3915
+ "enum": ["enable", "disable", "toggle"]
3916
+ }
3917
+ },
3918
+ "required": ["name", "operation"],
3919
+ "additionalProperties": false
3920
+ }
3921
+ ```
3922
+
3923
+ ## `updateMeasure`
3924
+
3925
+ Update measure
3926
+
3927
+ Modify properties of an existing measure
3928
+
3929
+ **Payload schema**
3930
+
3931
+ ```json
3932
+ {
3933
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3934
+ "title": "Update measure schema",
3935
+ "type": "object",
3936
+ "properties": {
3937
+ "dataItemInternalKey": {
3938
+ "description": "Internal key of the data item of the measure to be updated",
3939
+ "type": "string"
3940
+ },
3941
+ "dataItemUniqueSignature": {
3942
+ "description": "Unique signature of the data item of the measure to be updated",
3943
+ "type": "string"
3944
+ },
3945
+ "changes": {
3946
+ "type": "object",
3947
+ "properties": {
3948
+ "customLabel": {
3949
+ "type": "object",
3950
+ "properties": {
3951
+ "enabled": {
3952
+ "type": "boolean"
3953
+ },
3954
+ "value": {
3955
+ "type": "string"
3956
+ }
3957
+ },
3958
+ "required": ["enabled"],
3959
+ "additionalProperties": false
3960
+ }
3961
+ },
3962
+ "required": ["customLabel"],
3963
+ "additionalProperties": false
3964
+ }
3965
+ },
3966
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "changes"],
3967
+ "additionalProperties": false
3968
+ }
3969
+ ```