waterfall operations
Reference for @astrato-io/visualizations@0.6.5.
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.
Available operations
Section titled “Available operations”addDimensionaddMeasureaddMeasureAxisBandaddMeasureFilteraddResultFilterchangeMeasureAggregationclearMeasureFilterclearResultFilterduplicateDimensionduplicateMeasureremoveDimensionremoveMeasureremoveMeasureAxisBandsetAnimationEnabledsetAxisLabelColorsetAxisLineColorsetAxisRangeMaxsetAxisRangeMinsetAxisRangeOptionsetAxisStartsAtZerosetAxisTickColorsetAxisTitlesetAxisTitleColorsetDimensionFormatStringsetDimensionFormatTypesetDimensionTemporalGroupingsetInvertAxissetLabelOverlapsetMeasureAxisBandssetMeasureCurrencysetMeasureCurrencyIsPrefixsetMeasureDataLabelFontSizesetMeasureDataLabelShowBackdropsetMeasureDataLabelsShowsetMeasureDefinedParametersetMeasureFiltersetMeasureFormatStringsetMeasureFormatTypesetMeasureNegativeTypesetOrientationsetResultFiltersetShowAxisLabelssetShowAxisLinesetShowAxisTickssetShowAxisTitlesetShowAxisTooltipsetStaticFilterGroupsetSupportingMeasureEnabledsetWaterfallTotalDataLabelFontSizesetWaterfallTotalDataLabelShowsetWaterfallTotalDataLabelShowBackdroptoggleDimensiontoggleDimensionOrMeasureByNametoggleMeasureupdateDimensionupdateMeasure
addDimension
Section titled “addDimension”Add dimension
Add a new dimension to the chart
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "key": { "type": "string", "description": "Engine key of the field to be added as a dimension, eg. \"[Cars].[Horsepower]\"" } }, "required": ["key"], "additionalProperties": false, "title": "Add dimension schema"}addMeasure
Section titled “addMeasure”Add measure
Add a new measure to the chart
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "oneOf": [ { "type": "object", "properties": { "sourceKind": { "type": "string", "const": "field", "description": "Raw database field from available data `fields`." }, "key": { "type": "string", "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"" }, "aggregation": { "type": "string", "description": "Required for raw database fields. Use one of the aggregation names returned for that field." } }, "required": ["sourceKind", "key", "aggregation"], "additionalProperties": false }, { "type": "object", "properties": { "sourceKind": { "type": "string", "const": "measure", "description": "Predefined/user-defined measure from available data `measures`." }, "key": { "type": "string", "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"" } }, "required": ["sourceKind", "key"], "additionalProperties": false }, { "type": "object", "properties": { "sourceKind": { "type": "string", "const": "calculation", "description": "Predefined calculation from available data `measures`." }, "key": { "type": "string", "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"" } }, "required": ["sourceKind", "key"], "additionalProperties": false } ], "title": "Add measure schema"}addMeasureAxisBand
Section titled “addMeasureAxisBand”Add measure axis band
Add a shaded band on the primary measure axis between two measure values
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "start": { "type": "number", "description": "Measure axis value where the band starts" }, "end": { "type": "number", "description": "Measure axis value where the band ends" }, "color": { "description": "Band fill as #RRGGBB or #RRGGBBAA; defaults to a light grey when omitted", "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, "label": { "description": "Text drawn inside the band", "type": "string" } }, "required": ["start", "end"], "additionalProperties": false, "title": "Add measure axis band schema"}addMeasureFilter
Section titled “addMeasureFilter”Add measure filter
Add another measure filter before aggregation. Keeps existing filters.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "fieldKey": { "type": "string", "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label." }, "operator": { "type": "string", "enum": [ "equals", "doesNotEqual", "greaterThan", "lessThan", "greaterThanOrEqualTo", "lessThanOrEqualTo", "contains", "excludes", "like", "notLike", "startsWith", "endsWith" ], "description": "Filter operator that requires a value" }, "value": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Filter value" } }, "required": ["measureName", "fieldKey", "operator", "value"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "fieldKey": { "type": "string", "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label." }, "operator": { "type": "string", "enum": ["isBetween", "isNotBetween"], "description": "Filter operator that requires valueFrom and valueTo" }, "valueFrom": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Lower filter value" }, "valueTo": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Upper filter value" } }, "required": ["measureName", "fieldKey", "operator", "valueFrom", "valueTo"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "fieldKey": { "type": "string", "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label." }, "operator": { "type": "string", "enum": ["inList", "excludedFromList"], "description": "Filter operator that requires a list of values" }, "values": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Filter values" } }, "required": ["measureName", "fieldKey", "operator", "values"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "fieldKey": { "type": "string", "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label." }, "operator": { "type": "string", "enum": ["isNull", "notNull"], "description": "Filter operator that does not require values" } }, "required": ["measureName", "fieldKey", "operator"], "additionalProperties": false } ], "description": "Add another measure filter before aggregation. Keeps existing filters.", "title": "Add measure filter schema"}addResultFilter
Section titled “addResultFilter”Add result filter
Add another result filter after aggregation. Keeps existing result filters.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "operator": { "type": "string", "enum": [ "equals", "doesNotEqual", "greaterThan", "lessThan", "greaterThanOrEqualTo", "lessThanOrEqualTo", "contains", "excludes", "like", "notLike", "startsWith", "endsWith" ], "description": "Filter operator that requires a value" }, "value": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Filter value" } }, "required": ["measureName", "operator", "value"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "operator": { "type": "string", "enum": ["isBetween", "isNotBetween"], "description": "Filter operator that requires valueFrom and valueTo" }, "valueFrom": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Lower filter value" }, "valueTo": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Upper filter value" } }, "required": ["measureName", "operator", "valueFrom", "valueTo"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "operator": { "type": "string", "enum": ["inList", "excludedFromList"], "description": "Filter operator that requires a list of values" }, "values": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Filter values" } }, "required": ["measureName", "operator", "values"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "operator": { "type": "string", "enum": ["isNull", "notNull"], "description": "Filter operator that does not require values" } }, "required": ["measureName", "operator"], "additionalProperties": false } ], "description": "Add another result filter after aggregation. Keeps existing result filters.", "title": "Add result filter schema"}changeMeasureAggregation
Section titled “changeMeasureAggregation”Measure aggregation
Change how a measure is aggregated
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "aggregation": { "type": "string", "minLength": 1, "description": "Aggregation function to be used for the measure" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "aggregation"], "additionalProperties": false, "title": "Change measure aggregation schema"}clearMeasureFilter
Section titled “clearMeasureFilter”Clear measure filter
Clear measure filters before aggregation. Use fieldKey for one field; omit it for all.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "fieldKey": { "type": "string", "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." } }, "required": ["measureName"], "additionalProperties": false, "description": "Clear measure filters before aggregation. Use fieldKey for one field; omit it for all.", "title": "Clear measure filter schema"}clearResultFilter
Section titled “clearResultFilter”Clear result filter
Clear all result filters for one measure.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" } }, "required": ["measureName"], "additionalProperties": false, "description": "Clear all result filters for one measure.", "title": "Clear result filter schema"}duplicateDimension
Section titled “duplicateDimension”Duplicate dimension
Create a copy of an existing dimension
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the dimension to be duplicated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the dimension to be duplicated" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Duplicate dimension schema"}duplicateMeasure
Section titled “duplicateMeasure”Duplicate measure
Create a copy of an existing measure
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be duplicated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be duplicated" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Duplicate measure schema"}removeDimension
Section titled “removeDimension”Remove dimension
Remove a dimension from the chart
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the dimension to be removed" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the dimension to be removed" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Remove dimension schema"}removeMeasure
Section titled “removeMeasure”Remove measure
Remove a measure from the chart
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be removed" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be removed" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Remove measure schema"}removeMeasureAxisBand
Section titled “removeMeasureAxisBand”Remove measure axis band
Remove one shaded band from the primary measure axis by its position
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Zero-based position of the band to remove" } }, "required": ["index"], "additionalProperties": false, "title": "Remove measure axis band schema"}setAnimationEnabled
Section titled “setAnimationEnabled”Animations
Turn the chart animations on or off. They are on by default; the host can still disable them regardless of this setting
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether the chart animates when it first renders and when its data changes" } }, "required": ["enabled"], "additionalProperties": false, "title": "Set animation enabled schema"}setAxisLabelColor
Section titled “setAxisLabelColor”Axis label color
Change the color of axis value labels
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "labelColor": { "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ] }, "axisName": { "type": "string", "enum": ["primaryMeasure", "secondaryMeasure", "dimension"] } }, "required": ["axisName"], "additionalProperties": false, "title": "Axis label color schema"}setAxisLineColor
Section titled “setAxisLineColor”Axis line color
Change the color of axis lines
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "lineColor": { "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ] }, "axisName": { "type": "string", "enum": ["primaryMeasure", "secondaryMeasure", "dimension"] } }, "required": ["axisName"], "additionalProperties": false, "title": "Axis line color schema"}setAxisRangeMax
Section titled “setAxisRangeMax”Axis range maximum
Set the maximum of a measure axis. Applies only when the axis range option is minmax or max, e.g. to give several charts the same scale.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "axisName": { "type": "string", "enum": ["primaryMeasure"] }, "maxValue": { "type": "number" } }, "required": ["axisName", "maxValue"], "additionalProperties": false, "title": "Axis range max schema"}setAxisRangeMin
Section titled “setAxisRangeMin”Axis range minimum
Set the minimum of a measure axis. Applies only when the axis range option is minmax or min, e.g. to give several charts the same scale.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "axisName": { "type": "string", "enum": ["primaryMeasure"] }, "minValue": { "type": "number" } }, "required": ["axisName", "minValue"], "additionalProperties": false, "title": "Axis range min schema"}setAxisRangeOption
Section titled “setAxisRangeOption”Axis range
Choose how a measure axis range is set: auto fits the data, minmax fixes both ends, min or max fixes one end. Fixed ends take their values from setAxisRangeMin and setAxisRangeMax.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "axisName": { "type": "string", "enum": ["primaryMeasure"] }, "axisRangeOption": { "type": "string", "enum": ["auto", "minmax", "max", "min"] } }, "required": ["axisName", "axisRangeOption"], "additionalProperties": false, "title": "Axis range option schema"}setAxisStartsAtZero
Section titled “setAxisStartsAtZero”Axis starts at zero
Make an auto-ranged measure axis always include zero. Applies only when the axis range option is auto.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "axisName": { "type": "string", "enum": ["primaryMeasure"] }, "startsAtZero": { "type": "boolean" } }, "required": ["axisName", "startsAtZero"], "additionalProperties": false, "title": "Axis starts at zero schema"}setAxisTickColor
Section titled “setAxisTickColor”Axis tick color
Change the color of axis tick marks
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "tickColor": { "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ] }, "axisName": { "type": "string", "enum": ["primaryMeasure", "secondaryMeasure", "dimension"] } }, "required": ["axisName"], "additionalProperties": false, "title": "Axis tick color schema"}setAxisTitle
Section titled “setAxisTitle”Axis title
Set a custom title for an axis
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "axisTitle": { "type": "string" }, "axisName": { "type": "string", "enum": ["primaryMeasure", "secondaryMeasure", "dimension"] } }, "required": ["axisName"], "additionalProperties": false, "title": "Axis title schema"}setAxisTitleColor
Section titled “setAxisTitleColor”Axis title color
Change the color of axis titles
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "titleColor": { "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ] }, "axisName": { "type": "string", "enum": ["primaryMeasure", "secondaryMeasure", "dimension"] } }, "required": ["axisName"], "additionalProperties": false, "title": "Axis title color schema"}setDimensionFormatString
Section titled “setDimensionFormatString”Dimension format string
Set the custom display format string for a dimension. This changes label formatting only and does not change temporal grouping.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the dimension to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the dimension to be updated" }, "formatString": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Dimension format string schema"}setDimensionFormatType
Section titled “setDimensionFormatType”Dimension format type
Set the display format type used by a dimension. This changes label formatting only and does not change temporal grouping.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the dimension to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the dimension to be updated" }, "formatType": { "anyOf": [ { "type": "string", "enum": [ "custom", "inherit", "none", "defaultNumber", "defaultMoney", "numberNoDecimal", "number1Decimal", "number2Decimal", "abbreviationAuto", "abbreviationNoDecimal", "abbreviation1Decimal", "abbreviation2Decimal", "percentageNoDecimal", "percentage1Decimal", "percentage2Decimal", "money0Decimal", "money2Decimal", "durationDays", "durationHours", "durationMinutes", "durationSeconds" ] }, { "type": "string", "enum": [ "defaultDate", "defaultDatetime", "defaultTime", "ddmmyyyy", "ddmmyyyy2", "ddmmyyyy3", "yyyymmdd", "mmddyyyy", "mmddyyyy2", "ddmmmmyyyy", "ddmmmyyyy", "ddmmmyy", "mmmmddyyyy", "yyyy", "yy", "mmmyyyy", "yyyymmm", "yyyymmmm", "mmyyyy", "yyyymm", "mmmmyyyy", "yyyywn", "wnyyyy", "yywn", "yyyyq", "qyyyy", "yyyymmddhhmmss", "yyyymmddhmmss", "yyyymmddhhmm", "yyyymmddhh", "yyyymmddhmm", "yyyymmddh", "ddmmmyyyyhhmmss", "ddmmmyyyyhmmss", "ddmmmyyyyhhmm", "ddmmmyyyyhmm", "ddmmmyyyyh", "hhmmss", "hhmm", "hmm", "h", "hh", "hmmss", "month", "month2", "monthn", "month3", "quarter", "quarter2", "week1", "week2", "week3", "day", "dayOfWeek", "hhn", "hn" ] } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "formatType"], "additionalProperties": false, "title": "Dimension format type schema"}setDimensionTemporalGrouping
Section titled “setDimensionTemporalGrouping”Dimension temporal grouping
Set the temporal grouping of a date dimension. Use mode “level” with dateLevel for year-aware buckets such as month-over-time, mode “part” with datePart for date parts such as month-of-year, or mode “none” to clear temporal grouping.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "oneOf": [ { "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the dimension to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the dimension to be updated" }, "mode": { "type": "string", "const": "none" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "mode"], "additionalProperties": false }, { "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the dimension to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the dimension to be updated" }, "mode": { "type": "string", "const": "level" }, "dateLevel": { "type": "string", "enum": [ "year", "year-end", "quarter", "quarter-end", "month", "month-end", "week", "week-end", "day", "hour", "minute", "second" ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "mode", "dateLevel"], "additionalProperties": false }, { "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the dimension to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the dimension to be updated" }, "mode": { "type": "string", "const": "part" }, "datePart": { "type": "string", "enum": [ "year", "month", "day", "dayofweekiso", "dayofyear", "weekiso", "quarter", "yearofweekiso", "hour", "minute", "second" ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "mode", "datePart"], "additionalProperties": false } ], "title": "Dimension temporal grouping schema"}setInvertAxis
Section titled “setInvertAxis”Invert axis
Reverse the direction of an axis. axisName defaults to the dimension axis; pass a measure axis to flip its value scale, e.g. to put rank 1 at the top.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "invertAxis": { "type": "boolean" }, "axisName": { "type": "string", "enum": ["dimension", "primaryMeasure"] } }, "required": ["invertAxis"], "additionalProperties": false, "title": "Invert axis schema"}setLabelOverlap
Section titled “setLabelOverlap”Axis label overlap
Control how axis labels behave when they overlap
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "labelOverlap": { "type": "string", "enum": ["auto", "show-last"] } }, "additionalProperties": false, "title": "Label overlap schema"}setMeasureAxisBands
Section titled “setMeasureAxisBands”Measure axis bands
Replace all shaded bands on the primary measure axis. Each band fills the plot between two measure values
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "bands": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "number", "description": "Measure axis value where the band starts" }, "end": { "type": "number", "description": "Measure axis value where the band ends" }, "color": { "description": "Band fill as #RRGGBB or #RRGGBBAA; defaults to a light grey when omitted", "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, "label": { "description": "Text drawn inside the band", "type": "string" } }, "required": ["start", "end"], "additionalProperties": false }, "description": "Bands to draw, in order; an empty array removes all bands" } }, "required": ["bands"], "additionalProperties": false, "title": "Set measure axis bands schema"}setMeasureCurrency
Section titled “setMeasureCurrency”Measure currency
Set the currency symbol used by a measure formatter
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "currency": { "type": "string" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Measure currency schema"}setMeasureCurrencyIsPrefix
Section titled “setMeasureCurrencyIsPrefix”Measure currency is prefix
Set whether measure currency symbol is prefixed
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "currencyIsPrefix": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Measure currency is prefix schema"}setMeasureDataLabelFontSize
Section titled “setMeasureDataLabelFontSize”Measure data label font size
Set the font size of data labels for a measure
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "fontSize": { "anyOf": [ { "type": "number" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Set measure data label font size schema"}setMeasureDataLabelShowBackdrop
Section titled “setMeasureDataLabelShowBackdrop”Measure data label backdrop
Show or hide the backdrop behind measure data labels
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "showBackdrop": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Set measure data label backdrop schema"}setMeasureDataLabelsShow
Section titled “setMeasureDataLabelsShow”Show measure data labels
Show or hide data labels for a measure
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "show": { "type": "boolean" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Set measure data labels show schema"}setMeasureDefinedParameter
Section titled “setMeasureDefinedParameter”Measure defined parameter
Configure a Defined parameter of a custom measure using its default, a static value, or an existing compatible workbook variable
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "collectionKey": { "description": "Measure collection to update. Defaults to primary measures.", "type": "string", "enum": ["measures", "supportingMeasures"] }, "parameterName": { "type": "string", "minLength": 1, "description": "Exact name of a Defined parameter exposed by the measure" }, "value": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "default" } }, "required": ["type"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "static" }, "value": { "type": ["string", "number", "boolean"] } }, "required": ["type", "value"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string", "minLength": 1, "description": "Exact name of an existing compatible workbook variable" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Use default to remove the override, static for a literal value, or variable to bind a workbook variable" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "parameterName", "value"], "additionalProperties": false, "title": "Set measure defined parameter schema"}setMeasureFilter
Section titled “setMeasureFilter”Set measure filter
Set one measure filter before aggregation. Adds if none, replaces if one, fails if multiple.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "fieldKey": { "type": "string", "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label." }, "operator": { "type": "string", "enum": [ "equals", "doesNotEqual", "greaterThan", "lessThan", "greaterThanOrEqualTo", "lessThanOrEqualTo", "contains", "excludes", "like", "notLike", "startsWith", "endsWith" ], "description": "Filter operator that requires a value" }, "value": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Filter value" } }, "required": ["measureName", "fieldKey", "operator", "value"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "fieldKey": { "type": "string", "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label." }, "operator": { "type": "string", "enum": ["isBetween", "isNotBetween"], "description": "Filter operator that requires valueFrom and valueTo" }, "valueFrom": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Lower filter value" }, "valueTo": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Upper filter value" } }, "required": ["measureName", "fieldKey", "operator", "valueFrom", "valueTo"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "fieldKey": { "type": "string", "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label." }, "operator": { "type": "string", "enum": ["inList", "excludedFromList"], "description": "Filter operator that requires a list of values" }, "values": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Filter values" } }, "required": ["measureName", "fieldKey", "operator", "values"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "fieldKey": { "type": "string", "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label." }, "operator": { "type": "string", "enum": ["isNull", "notNull"], "description": "Filter operator that does not require values" } }, "required": ["measureName", "fieldKey", "operator"], "additionalProperties": false } ], "description": "Set one measure filter before aggregation. Adds if none, replaces if one, fails if multiple.", "title": "Set measure filter schema"}setMeasureFormatString
Section titled “setMeasureFormatString”Measure format string
Set the custom format string for a measure
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "formatString": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Measure format string schema"}setMeasureFormatType
Section titled “setMeasureFormatType”Measure format type
Set the format type used by a measure
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "formatType": { "anyOf": [ { "type": "string", "enum": [ "custom", "inherit", "none", "defaultNumber", "defaultMoney", "numberNoDecimal", "number1Decimal", "number2Decimal", "abbreviationAuto", "abbreviationNoDecimal", "abbreviation1Decimal", "abbreviation2Decimal", "percentageNoDecimal", "percentage1Decimal", "percentage2Decimal", "money0Decimal", "money2Decimal", "durationDays", "durationHours", "durationMinutes", "durationSeconds" ] }, { "type": "string", "enum": [ "defaultDate", "defaultDatetime", "defaultTime", "ddmmyyyy", "ddmmyyyy2", "ddmmyyyy3", "yyyymmdd", "mmddyyyy", "mmddyyyy2", "ddmmmmyyyy", "ddmmmyyyy", "ddmmmyy", "mmmmddyyyy", "yyyy", "yy", "mmmyyyy", "yyyymmm", "yyyymmmm", "mmyyyy", "yyyymm", "mmmmyyyy", "yyyywn", "wnyyyy", "yywn", "yyyyq", "qyyyy", "yyyymmddhhmmss", "yyyymmddhmmss", "yyyymmddhhmm", "yyyymmddhh", "yyyymmddhmm", "yyyymmddh", "ddmmmyyyyhhmmss", "ddmmmyyyyhmmss", "ddmmmyyyyhhmm", "ddmmmyyyyhmm", "ddmmmyyyyh", "hhmmss", "hhmm", "hmm", "h", "hh", "hmmss", "month", "month2", "monthn", "month3", "quarter", "quarter2", "week1", "week2", "week3", "day", "dayOfWeek", "hhn", "hn" ] } ] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "formatType"], "additionalProperties": false, "title": "Measure format type schema"}setMeasureNegativeType
Section titled “setMeasureNegativeType”Measure negative type
Set how negative values are displayed for a measure formatter
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "negativeType": { "type": "string", "enum": ["symbol", "parenthesis"] } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Measure negative type schema"}setOrientation
Section titled “setOrientation”Orientation
Set the orientation of the waterfall chart
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Waterfall chart orientation schema", "type": "string", "enum": ["horizontal", "vertical"]}setResultFilter
Section titled “setResultFilter”Set result filter
Set one result filter after aggregation. Adds if none, replaces if one, fails if multiple.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "operator": { "type": "string", "enum": [ "equals", "doesNotEqual", "greaterThan", "lessThan", "greaterThanOrEqualTo", "lessThanOrEqualTo", "contains", "excludes", "like", "notLike", "startsWith", "endsWith" ], "description": "Filter operator that requires a value" }, "value": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Filter value" } }, "required": ["measureName", "operator", "value"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "operator": { "type": "string", "enum": ["isBetween", "isNotBetween"], "description": "Filter operator that requires valueFrom and valueTo" }, "valueFrom": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Lower filter value" }, "valueTo": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ], "description": "Upper filter value" } }, "required": ["measureName", "operator", "valueFrom", "valueTo"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "operator": { "type": "string", "enum": ["inList", "excludedFromList"], "description": "Filter operator that requires a list of values" }, "values": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Filter values" } }, "required": ["measureName", "operator", "values"], "additionalProperties": false }, { "type": "object", "properties": { "measureName": { "type": "string", "description": "Visible measure name or label" }, "operator": { "type": "string", "enum": ["isNull", "notNull"], "description": "Filter operator that does not require values" } }, "required": ["measureName", "operator"], "additionalProperties": false } ], "description": "Set one result filter after aggregation. Adds if none, replaces if one, fails if multiple.", "title": "Set result filter schema"}setShowAxisLabels
Section titled “setShowAxisLabels”Show axis labels
Show or hide value labels on chart axes
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "showLabels": { "type": "boolean" }, "axisName": { "type": "string", "enum": ["primaryMeasure", "secondaryMeasure", "dimension"] } }, "required": ["axisName"], "additionalProperties": false, "title": "Axis labels schema"}setShowAxisLine
Section titled “setShowAxisLine”Show axis line
Show or hide the axis lines on the chart
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "showAxisLine": { "type": "boolean" }, "axisName": { "type": "string", "enum": ["primaryMeasure", "secondaryMeasure", "dimension"] } }, "required": ["axisName"], "additionalProperties": false, "title": "Axis line schema"}setShowAxisTicks
Section titled “setShowAxisTicks”Show axis ticks
Show or hide tick marks on chart axes
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "showAxisTicks": { "type": "boolean" }, "axisName": { "type": "string", "enum": ["primaryMeasure", "secondaryMeasure", "dimension"] } }, "required": ["axisName"], "additionalProperties": false, "title": "Axis ticks schema"}setShowAxisTitle
Section titled “setShowAxisTitle”Show axis title
Show or hide axis titles on the chart
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "showAxisName": { "type": "boolean" }, "axisName": { "type": "string", "enum": ["primaryMeasure", "secondaryMeasure", "dimension"] } }, "required": ["axisName"], "additionalProperties": false, "title": "Axis title schema"}setShowAxisTooltip
Section titled “setShowAxisTooltip”Show axis tooltip
Show or hide tooltips when hovering over axis values
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "showAxisTooltip": { "type": "boolean" }, "axisName": { "type": "string", "enum": ["primaryMeasure", "secondaryMeasure", "dimension"] } }, "required": ["axisName"], "additionalProperties": false, "title": "Show axis tooltip schema"}setStaticFilterGroup
Section titled “setStaticFilterGroup”Set static filter group
Replace all static filters with a nested AND/OR filter group.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Replace all static filters with this nested AND/OR filter group.", "title": "Set static filter group schema", "$ref": "#/$defs/__schema0", "$defs": { "__schema0": { "type": "object", "properties": { "operator": { "type": "string", "enum": ["and", "or"] }, "filters": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "fieldKey": { "type": "string", "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label." }, "operator": { "anyOf": [ { "type": "string", "enum": [ "equals", "doesNotEqual", "greaterThan", "lessThan", "greaterThanOrEqualTo", "lessThanOrEqualTo", "isBetween", "isNotBetween", "isNull", "notNull", "contains", "excludes", "like", "notLike", "startsWith", "endsWith", "predefined_date_range", "previous", "current", "before", "after", "inList", "excludedFromList", "divider" ] }, { "type": "string", "enum": [ "ytd", "mtd", "qtd", "wtd", "pytd", "pmtd", "pqtd", "pwtd", "l12m", "l90d", "l30d", "l7d", "cy", "cq", "cm", "py", "pm", "pq", "pw", "today", "yesterday", "mindate", "maxdate" ] } ] }, "values": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] }, "valueFrom": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] }, "valueTo": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] }, "secondValue": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] } }, "additionalProperties": false }, "dateFilter": { "anyOf": [ { "type": "string", "enum": [ "ytd", "mtd", "qtd", "wtd", "pytd", "pmtd", "pqtd", "pwtd", "l12m", "l90d", "l30d", "l7d", "cy", "cq", "cm", "py", "pm", "pq", "pw", "today", "yesterday", "mindate", "maxdate" ] }, { "type": "null" } ] } }, "required": ["fieldKey", "operator", "values"], "additionalProperties": false }, { "$ref": "#/$defs/__schema0" } ] } } }, "required": ["operator", "filters"], "additionalProperties": false } }}setSupportingMeasureEnabled
Section titled “setSupportingMeasureEnabled”Supporting measure enabled
Enable or disable all matching supporting measures by name
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "enabled": { "type": "boolean" } }, "required": ["name", "enabled"], "additionalProperties": false, "title": "Supporting measure enabled by name schema"}setWaterfallTotalDataLabelFontSize
Section titled “setWaterfallTotalDataLabelFontSize”Total data label font size
Set the font size of the total data label
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Waterfall total data label font size schema", "anyOf": [ { "type": "number" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ]}setWaterfallTotalDataLabelShow
Section titled “setWaterfallTotalDataLabelShow”Show total data label
Show or hide the total data label
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "boolean", "title": "Waterfall total data label show schema"}setWaterfallTotalDataLabelShowBackdrop
Section titled “setWaterfallTotalDataLabelShowBackdrop”Total data label backdrop
Show or hide the backdrop behind the total data label
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "boolean", "title": "Waterfall total data label backdrop schema"}toggleDimension
Section titled “toggleDimension”Toggle dimension
Enable or disable a dimension in the chart
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the dimension to be toggled" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the dimension to be toggled" }, "enabled": { "type": "boolean", "description": "Whether the dimension should be enabled or disabled" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "enabled"], "additionalProperties": false, "title": "Toggle dimension schema"}toggleDimensionOrMeasureByName
Section titled “toggleDimensionOrMeasureByName”Toggle dimension/measure by name
Enable, disable, or toggle a dimension or measure by its name
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string" }, "operation": { "type": "string", "enum": ["enable", "disable", "toggle"] } }, "required": ["name", "operation"], "additionalProperties": false, "title": "Toggle dimension or measure by name schema"}toggleMeasure
Section titled “toggleMeasure”Toggle measure
Enable or disable a measure in the chart
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be toggled" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be toggled" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Toggle measure schema"}updateDimension
Section titled “updateDimension”Update dimension
Modify properties of an existing dimension
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the dimension to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the dimension to be updated" }, "changes": { "type": "object", "properties": { "customLabel": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "string" } }, "required": ["enabled"], "additionalProperties": false }, "showNullValues": { "type": "boolean" } }, "additionalProperties": false } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "changes"], "additionalProperties": false, "title": "Update dimension schema"}updateMeasure
Section titled “updateMeasure”Update measure
Modify properties of an existing measure
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the measure to be updated" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the measure to be updated" }, "changes": { "type": "object", "properties": { "customLabel": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "string" } }, "required": ["enabled"], "additionalProperties": false } }, "required": ["customLabel"], "additionalProperties": false } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "changes"], "additionalProperties": false, "title": "Update measure schema"}