tree 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”addDimensionaddMeasureaddMeasureFilteraddResultFilterchangeMeasureAggregationchangeSortOrderAndDirectionclearMeasureFilterclearResultFilterduplicateDimensionduplicateMeasureenableCustomNullValueenableQueryTimeoutenableTopNremoveDimensionremoveMeasuresetCustomNullValuesetDimensionFormatStringsetDimensionFormatTypesetDimensionTemporalGroupingsetExportLimitsetHideZeroValuessetMeasureCurrencysetMeasureCurrencyIsPrefixsetMeasureDefinedParametersetMeasureFiltersetMeasureFormatStringsetMeasureFormatTypesetMeasureNegativeTypesetOthersPositionsetQueryLimitsetQueryTimeoutsetResultFiltersetSortingDirectionsetSortingEnabledsetStaticFilterGroupsetTimeTravelsetTopNNumberOfValuessetTopNOthersLabelsetTopNRankEachDimensionIndividuallysetTopNShowOtherssetTopNSortOrdersetTreeCompactsetTreeDirectionOriginsetTreeForceAutoFitsetTreeInitialExpandedLevelssetTreeLabelFontSizesetTreeNodeBackgroundColorsetTreeNodeBorderColorsetTreeNodeBorderEnabledsetTreeNodeBorderRadiussetTreeNodeBorderStylesetTreeNodeBorderWidthsetTreeNodeLayoutPresetsetTreeValueFontSizetoggleDimensiontoggleDimensionOrMeasureByNametoggleMeasuretoggleSortingItemupdateDimensionupdateMeasure
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"}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"}changeSortOrderAndDirection
Section titled “changeSortOrderAndDirection”Sort order and direction
Change how data is sorted
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "changeRequests": { "type": "array", "items": { "type": "object", "properties": { "dataItemInternalKey": { "type": "string" }, "dataItemUniqueSignature": { "type": "string" }, "sortDirection": { "type": "string", "enum": ["asc", "desc"] }, "newIndex": { "type": "number", "description": "Index of the item representing the new item position" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "sortDirection", "newIndex"], "additionalProperties": false, "description": "Sort order and direction change request - single request for each item, all items must be present" } } }, "required": ["changeRequests"], "additionalProperties": false, "title": "Change sort order and direction 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"}enableCustomNullValue
Section titled “enableCustomNullValue”Enable custom null value
Enable custom text display for null or empty values
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Enable custom null value schema", "type": "boolean"}enableQueryTimeout
Section titled “enableQueryTimeout”Enable query timeout
Enable or disable query timeout to limit long-running queries
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "boolean", "title": "Query timeout enabled schema"}enableTopN
Section titled “enableTopN”Enable top N
Enable top N filtering to show only the highest or lowest values
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "boolean", "title": "Enable top N 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"}setCustomNullValue
Section titled “setCustomNullValue”Custom null value
Set what text to display for null or empty values
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] }, { "type": "null" } ], "title": "Set custom null value 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"}setExportLimit
Section titled “setExportLimit”Export limit
Limit the number of rows when exporting chart data
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Set export limit schema", "type": ["number", "null"]}setHideZeroValues
Section titled “setHideZeroValues”Hide zero values
Hide or show nodes with zero values
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Set hide zero values schema", "type": "boolean"}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"}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"}setOthersPosition
Section titled “setOthersPosition”Top N others position
Set where the “Others” category appears in the chart
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Position of \"Others\" item - first (at the beginning), last (at the end) or default (let engine decide)", "title": "Set others position schema", "type": "string", "enum": ["default", "first", "last"]}setQueryLimit
Section titled “setQueryLimit”Query limit
Limit the number of rows returned from the database query
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Set query limit schema", "type": ["number", "null"]}setQueryTimeout
Section titled “setQueryTimeout”Set query timeout
Set the timeout duration for database queries in seconds
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Query timeout schema", "anyOf": [ { "type": "number", "minimum": 120, "maximum": 600 }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ]}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"}setSortingDirection
Section titled “setSortingDirection”Sorting direction
Set sorting direction for all matching sortable items by name
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "sortDirection": { "type": "string", "enum": ["ascending", "descending"] } }, "required": ["name", "sortDirection"], "additionalProperties": false, "title": "Sorting direction by name schema"}setSortingEnabled
Section titled “setSortingEnabled”Sorting enabled
Enable or disable sorting for all matching sortable items 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"], "additionalProperties": false, "title": "Sorting enabled by name 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 } }}setTimeTravel
Section titled “setTimeTravel”Time travel
Set time travel settings for the chart query
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "type": { "type": "string", "enum": ["timestamp", "offset", "none"], "description": "Time travel type" }, "month": { "description": "Month", "type": "string" }, "day": { "description": "Day", "type": "string" }, "time": { "description": "Time", "type": "string" }, "offsetDays": { "description": "Offset days", "type": "string" }, "offsetHours": { "description": "Offset hours", "type": "string" }, "offsetMinutes": { "description": "Offset minutes", "type": "string" } }, "required": ["type"], "additionalProperties": false, "title": "Time travel schema"}setTopNNumberOfValues
Section titled “setTopNNumberOfValues”Top N number of values
Set how many top values to display in the chart
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Set top N number of values schema", "anyOf": [ { "type": "number" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ]}setTopNOthersLabel
Section titled “setTopNOthersLabel”Top N others label
Set a custom label for the “Others” category
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "stringLabel": { "type": "string" } }, "additionalProperties": false, "title": "Set top N others label schema"}setTopNRankEachDimensionIndividually
Section titled “setTopNRankEachDimensionIndividually”Rank each dimension individually
Set whether Top N ranks each dimension independently when all dimensions are used. Pass true to enable or false to disable. Does not change the selected ranking dimension or enable Top N.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "boolean", "title": "Set top N rank each dimension individually schema"}setTopNShowOthers
Section titled “setTopNShowOthers”Top N show others
Show or hide an “Others” category for remaining values
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Group other values into one \"Others\" item", "title": "Set top N show others schema", "type": "boolean"}setTopNSortOrder
Section titled “setTopNSortOrder”Top N sort order
Set the sorting order for top N values
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Sort order (ascending or descending) to determine whether to show top or bottom N values", "title": "Set top N sort order schema", "type": "string", "enum": ["asc", "desc"]}setTreeCompact
Section titled “setTreeCompact”Tree compact mode
Enable or disable compact tree layout
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Tree compact mode schema", "type": "boolean"}setTreeDirectionOrigin
Section titled “setTreeDirectionOrigin”Tree direction
Set the direction from which the tree layout starts
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Tree direction origin schema", "type": "string", "enum": ["top", "bottom", "left", "right"]}setTreeForceAutoFit
Section titled “setTreeForceAutoFit”Tree force auto fit
Enable or disable forced auto-fit layout
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Tree force auto fit schema", "type": "boolean"}setTreeInitialExpandedLevels
Section titled “setTreeInitialExpandedLevels”Tree initial expanded levels
Set how many tree levels are expanded initially
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Tree initial expanded levels schema", "type": "number"}setTreeLabelFontSize
Section titled “setTreeLabelFontSize”Tree label font size
Set the font size for tree node labels
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Labels font size", "title": "Tree label font size schema", "anyOf": [ { "type": "number", "minimum": 8, "maximum": 24 }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ]}setTreeNodeBackgroundColor
Section titled “setTreeNodeBackgroundColor”Tree node background color
Set the background color of tree nodes
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ], "title": "Tree node background color schema"}setTreeNodeBorderColor
Section titled “setTreeNodeBorderColor”Tree node border color
Set the color of tree node borders
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ], "title": "Tree node border color schema"}setTreeNodeBorderEnabled
Section titled “setTreeNodeBorderEnabled”Tree node border enabled
Enable or disable borders around tree nodes
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "boolean", "title": "Tree node border enabled schema"}setTreeNodeBorderRadius
Section titled “setTreeNodeBorderRadius”Tree node border radius
Set the corner radius of tree nodes
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "number", "minimum": 0, "maximum": 20, "title": "Tree node border radius schema"}setTreeNodeBorderStyle
Section titled “setTreeNodeBorderStyle”Tree node border style
Set the line style of tree node borders
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": ["line", "dashed", "dotted"], "title": "Tree node border style schema"}setTreeNodeBorderWidth
Section titled “setTreeNodeBorderWidth”Tree node border width
Set the width of tree node borders
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "number", "minimum": 0, "maximum": 10, "title": "Tree node border width schema"}setTreeNodeLayoutPreset
Section titled “setTreeNodeLayoutPreset”Tree node layout preset
Set the tree node layout preset
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": ["basic", "kpiChange"], "title": "Tree node layout preset schema"}setTreeValueFontSize
Section titled “setTreeValueFontSize”Tree value font size
Set the font size for tree node values
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Labels font size", "title": "Tree value font size schema", "anyOf": [ { "type": "number", "minimum": 8, "maximum": 24 }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ]}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"}toggleSortingItem
Section titled “toggleSortingItem”Toggle sorting item
Enable or disable sorting for a field
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 sorting item" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the sorting item" }, "enabled": { "type": "boolean", "description": "Whether sorting should be enabled for the item" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature", "enabled"], "additionalProperties": false, "title": "Toggle sorting item 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"}