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