Skip to content
AstratoAstratoAstrato

number operations

6 min read · Updated 29 Oct 2026

Reference for @astrato-io/visualizations@0.6.5.

All visualization types

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”

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."
        },
        "role": {
          "type": "string",
          "enum": ["number-measure", "number-comparison"]
        }
      },
      "required": ["sourceKind", "key", "aggregation", "role"],
      "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]\""
        },
        "role": {
          "type": "string",
          "enum": ["number-measure", "number-comparison"]
        }
      },
      "required": ["sourceKind", "key", "role"],
      "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]\""
        },
        "role": {
          "type": "string",
          "enum": ["number-measure", "number-comparison"]
        }
      },
      "required": ["sourceKind", "key", "role"],
      "additionalProperties": false
    }
  ],
  "title": "Add measure schema"
}

addMeasureAdvancedAdditionalDimensionDataField

Section titled “addMeasureAdvancedAdditionalDimensionDataField”

Add advanced bottom dimension

Add bottom dimension field for nested ratio advanced calculation

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "key": {
      "type": "string",
      "description": "Engine key of the bottom dimension field to be added"
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "key"],
  "additionalProperties": false,
  "title": "Add measure advanced additional dimension field schema"
}

addMeasureAdvancedDimensionDataField

Section titled “addMeasureAdvancedDimensionDataField”

Add advanced additional dimension

Add additional dimension field for nested advanced calculations

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "key": {
      "type": "string",
      "description": "Engine key of the dimension field to be added"
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "key"],
  "additionalProperties": false,
  "title": "Add measure advanced dimension field 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"
}

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"
}

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"
}

removeMeasureAdvancedAdditionalDimensionDataField

Section titled “removeMeasureAdvancedAdditionalDimensionDataField”

Remove advanced bottom dimension

Remove bottom dimension field from nested ratio advanced calculation

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "internalKey": {
      "type": "string",
      "description": "Internal key of the bottom dimension field to be removed"
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "internalKey"],
  "additionalProperties": false,
  "title": "Remove measure advanced additional dimension field schema"
}

removeMeasureAdvancedCompareMeasure

Section titled “removeMeasureAdvancedCompareMeasure”

Remove advanced compare measure

Remove compare measure from advanced calculation

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
  "additionalProperties": false,
  "title": "Remove measure advanced compare measure schema"
}

removeMeasureAdvancedDimensionDataField

Section titled “removeMeasureAdvancedDimensionDataField”

Remove advanced additional dimension

Remove additional dimension field from nested advanced calculations

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "internalKey": {
      "type": "string",
      "description": "Internal key of the dimension field to be removed"
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "internalKey"],
  "additionalProperties": false,
  "title": "Remove measure advanced dimension field schema"
}

setComparisonFontColor

Section titled “setComparisonFontColor”

Comparison font color

Change the color of the comparison value display

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"
    }
  ],
  "description": "Font color (hex, with optional alpha)",
  "title": "Number comparison font color schema"
}

setComparisonFontFamily

Section titled “setComparisonFontFamily”

Comparison font family

Change the font family for the comparison value display

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Number comparison font family schema",
  "type": ["string", "null"]
}

setComparisonFontStyle

Section titled “setComparisonFontStyle”

Comparison font style

Apply font styling to the comparison value

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "weight": {
      "description": "Font weight",
      "type": ["number", "null"]
    },
    "bold": {
      "description": "Bold font. Should take precedence over weight",
      "type": "boolean"
    },
    "italic": {
      "type": "boolean"
    },
    "underlined": {
      "type": "boolean"
    },
    "strikethrough": {
      "type": "boolean"
    },
    "fontFamily": {
      "type": ["string", "null"]
    },
    "fontColor": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
        },
        {
          "type": "null"
        }
      ],
      "description": "Font color (hex, with optional alpha)"
    },
    "relativeFontSizePercentage": {
      "description": "Comparison font size as a percentage of the main number font size",
      "type": "number",
      "minimum": 0,
      "maximum": 200
    }
  },
  "additionalProperties": false,
  "title": "Number comparison font style schema"
}

setComparisonFontWeight

Section titled “setComparisonFontWeight”

Comparison font weight

Set the font weight of the comparison value display

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Font weight",
  "title": "Number comparison font weight schema",
  "type": ["number", "null"]
}

setComparisonGap

Section titled “setComparisonGap”

Comparison gap

Set the horizontal spacing between the main number and the comparison (none, small-gap, space-around, space-between); only applies when comparison is positioned left or right

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Horizontal spacing between number and comparison; only applies for left/right comparison",
  "title": "Number comparison gap schema",
  "type": "string",
  "enum": ["none", "small-gap", "space-around", "space-between"]
}

setComparisonPosition

Section titled “setComparisonPosition”

Comparison position

Set the position of the comparison value relative to the main number

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Number comparison position schema",
  "type": "string",
  "enum": ["left", "right", "top", "bottom", "center"]
}

setComparisonRelativeFontSizePercentage

Section titled “setComparisonRelativeFontSizePercentage”

Comparison relative font size

Adjust the comparison font size as a percentage of the main number font size

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Comparison font size as a percentage of the main number font size",
  "title": "Number comparison relative font size percentage schema",
  "type": "number",
  "minimum": 0,
  "maximum": 200
}

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"
}

setHorizontalAlign

Section titled “setHorizontalAlign”

Horizontal align

Set horizontal alignment of the number

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Number horizontal align schema",
  "type": "string",
  "enum": ["auto", "left", "center", "right"]
}

setIconPosition

Section titled “setIconPosition”

Icon position

Set the position of the icon relative to the number

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Number icon position schema",
  "type": "string",
  "enum": ["left", "right", "top", "bottom", "center"]
}

setMeasureAdvancedAdditionalAggregation

Section titled “setMeasureAdvancedAdditionalAggregation”

Advanced additional aggregation

Set additional aggregation used by nested ratio advanced calculation

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "additionalAggregation": {
      "type": "string",
      "enum": ["SUM", "AVG", "MIN", "MAX"]
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "additionalAggregation"],
  "additionalProperties": false,
  "title": "Measure advanced additional aggregation schema"
}

setMeasureAdvancedAggregation

Section titled “setMeasureAdvancedAggregation”

Advanced aggregation

Set aggregation used by advanced calculation 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"
    },
    "collectionKey": {
      "description": "Measure collection key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "aggregation": {
      "type": "string",
      "enum": ["SUM", "AVG", "MIN", "MAX", "PERCENTILE", "OUTLIERS", "CONTROL_VALUE"]
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "aggregation"],
  "additionalProperties": false,
  "title": "Measure advanced aggregation schema"
}

setMeasureAdvancedCalculationType

Section titled “setMeasureAdvancedCalculationType”

Advanced calculation type

Set advanced calculation type 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"
    },
    "advancedCalculationType": {
      "type": "string",
      "enum": [
        "nestedCalculation",
        "nestedRatio",
        "nestedCorrelation",
        "value",
        "diff",
        "ratio",
        "growth",
        "apg",
        "cagr"
      ]
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "advancedCalculationType"],
  "additionalProperties": false,
  "title": "Number advanced calculation type schema"
}

setMeasureAdvancedCompareMeasure

Section titled “setMeasureAdvancedCompareMeasure”

Advanced compare measure

Set compare measure used by accumulated growth or nested correlation

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "key": {
      "type": "string",
      "description": "Engine key of the compare measure field"
    },
    "aggregation": {
      "type": "string",
      "enum": ["SUM", "AVG", "MIN", "MAX", "PERCENTILE", "OUTLIERS", "CONTROL_VALUE"]
    },
    "parameters": {
      "anyOf": [
        {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "type": "object",
            "properties": {
              "value": {
                "anyOf": [
                  {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "const": "variable"
                          },
                          "variableName": {
                            "type": "string"
                          }
                        },
                        "required": ["type", "variableName"],
                        "additionalProperties": false
                      }
                    ]
                  },
                  {
                    "anyOf": [
                      {
                        "type": "number"
                      },
                      {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "const": "variable"
                          },
                          "variableName": {
                            "type": "string"
                          }
                        },
                        "required": ["type", "variableName"],
                        "additionalProperties": false
                      }
                    ]
                  },
                  {
                    "anyOf": [
                      {
                        "type": "boolean"
                      },
                      {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "const": "variable"
                          },
                          "variableName": {
                            "type": "string"
                          }
                        },
                        "required": ["type", "variableName"],
                        "additionalProperties": false
                      }
                    ]
                  }
                ]
              },
              "dataType": {
                "type": "string",
                "enum": [
                  "string",
                  "int",
                  "float",
                  "boolean",
                  "date",
                  "millisec",
                  "millisec_tz",
                  "timestamp",
                  "timestamp_tz"
                ]
              }
            },
            "required": ["value"],
            "additionalProperties": false
          }
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "key", "aggregation"],
  "additionalProperties": false,
  "title": "Set measure advanced compare measure schema"
}

setMeasureAdvancedComparisonType

Section titled “setMeasureAdvancedComparisonType”

Advanced comparison type

Set comparison type for period-over-correlation

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "comparisonType": {
      "type": "string",
      "enum": ["absolute", "percentage", "naturalLog"]
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "comparisonType"],
  "additionalProperties": false,
  "title": "Measure advanced comparison type schema"
}

setMeasureAdvancedDense

Section titled “setMeasureAdvancedDense”

Advanced dense rank

Enable or disable dense rank

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "dense": {
      "type": "boolean"
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "dense"],
  "additionalProperties": false,
  "title": "Measure advanced dense schema"
}

setMeasureAdvancedDimensionsIds

Section titled “setMeasureAdvancedDimensionsIds”

Advanced dimensions

Set dimensions used by advanced calculation

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "dimensionsIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "dimensionsIds"],
  "additionalProperties": false,
  "title": "Measure advanced dimensions schema"
}

setMeasureAdvancedGroupType

Section titled “setMeasureAdvancedGroupType”

Advanced group type

Set comparison group type for share total advanced calculation

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "groupType": {
      "type": "string",
      "enum": ["value", "diff", "ratio", "growth"]
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "groupType"],
  "additionalProperties": false,
  "title": "Measure advanced group type schema"
}

setMeasureAdvancedNonTimePeriod

Section titled “setMeasureAdvancedNonTimePeriod”

Advanced nested time dimension

Enable or disable nested time 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 measure to be updated"
    },
    "dataItemUniqueSignature": {
      "type": "string",
      "description": "Unique signature of the data item of the measure to be updated"
    },
    "collectionKey": {
      "description": "Measure collection key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "nonTimePeriod": {
      "type": "boolean"
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "nonTimePeriod"],
  "additionalProperties": false,
  "title": "Measure advanced nested time dimension schema"
}

setMeasureAdvancedNonTimePeriodGranularity

Section titled “setMeasureAdvancedNonTimePeriodGranularity”

Advanced non-time period granularity

Set non-time period granularity for inter-record calculations

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "nonTimePeriodGranularity": {
      "type": "string",
      "enum": ["day", "week", "month", "quarter", "year"]
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "nonTimePeriodGranularity"],
  "additionalProperties": false,
  "title": "Measure advanced non-time period granularity schema"
}

setMeasureAdvancedNullIfNotEnoughValues

Section titled “setMeasureAdvancedNullIfNotEnoughValues”

Advanced null if not enough values

Enable or disable null-if-not-enough-values for moving calculation

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "nullIfNotEnoughValues": {
      "type": "boolean"
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "nullIfNotEnoughValues"],
  "additionalProperties": false,
  "title": "Measure advanced null if not enough values schema"
}

setMeasureAdvancedOffset

Section titled “setMeasureAdvancedOffset”

Advanced compare with period offset

Set compare-with-period offset for advanced calculation

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "offset": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "const": "variable"
            },
            "variableName": {
              "type": "string"
            }
          },
          "required": ["type", "variableName"],
          "additionalProperties": false
        }
      ]
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "offset"],
  "additionalProperties": false,
  "title": "Measure advanced offset schema"
}

setMeasureAdvancedParameter

Section titled “setMeasureAdvancedParameter”

Advanced parameter

Set value for advanced operation parameter

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "variableName": {
      "type": "string",
      "description": "Name of advanced operation parameter to update"
    },
    "value": {
      "type": "object",
      "properties": {
        "value": {
          "anyOf": [
            {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "const": "variable"
                    },
                    "variableName": {
                      "type": "string"
                    }
                  },
                  "required": ["type", "variableName"],
                  "additionalProperties": false
                }
              ]
            },
            {
              "anyOf": [
                {
                  "type": "number"
                },
                {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "const": "variable"
                    },
                    "variableName": {
                      "type": "string"
                    }
                  },
                  "required": ["type", "variableName"],
                  "additionalProperties": false
                }
              ]
            },
            {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "const": "variable"
                    },
                    "variableName": {
                      "type": "string"
                    }
                  },
                  "required": ["type", "variableName"],
                  "additionalProperties": false
                }
              ]
            }
          ]
        },
        "dataType": {
          "type": "string",
          "enum": ["string", "int", "float", "boolean", "date", "millisec", "millisec_tz", "timestamp", "timestamp_tz"]
        }
      },
      "required": ["value"],
      "additionalProperties": false
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "variableName", "value"],
  "additionalProperties": false,
  "title": "Set measure advanced parameter schema"
}

setMeasureAdvancedPercentileApprox

Section titled “setMeasureAdvancedPercentileApprox”

Advanced percentile approx

Enable or disable approximate percentile mode

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "percentileApprox": {
      "type": "boolean"
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "percentileApprox"],
  "additionalProperties": false,
  "title": "Measure advanced percentile approx schema"
}

setMeasureAdvancedPercentileContinuous

Section titled “setMeasureAdvancedPercentileContinuous”

Advanced percentile continuous

Enable or disable continuous percentile mode

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "percentileContinuous": {
      "type": "boolean"
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "percentileContinuous"],
  "additionalProperties": false,
  "title": "Measure advanced percentile continuous schema"
}

setMeasureAdvancedPercentileValue

Section titled “setMeasureAdvancedPercentileValue”

Advanced percentile value

Set percentile value for percentile aggregation

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "percentileValue": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "const": "variable"
            },
            "variableName": {
              "type": "string"
            }
          },
          "required": ["type", "variableName"],
          "additionalProperties": false
        }
      ]
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "percentileValue"],
  "additionalProperties": false,
  "title": "Measure advanced percentile value schema"
}

setMeasureAdvancedPeriodsPerYear

Section titled “setMeasureAdvancedPeriodsPerYear”

Advanced periods per year

Set number of periods in a year for annualized period growth

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "periodsPerYear": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "const": "variable"
            },
            "variableName": {
              "type": "string"
            }
          },
          "required": ["type", "variableName"],
          "additionalProperties": false
        }
      ]
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "periodsPerYear"],
  "additionalProperties": false,
  "title": "Measure advanced periods per year schema"
}

setMeasureAdvancedRangesComparisonEnabled

Section titled “setMeasureAdvancedRangesComparisonEnabled”

Advanced ranges comparison enabled

Enable or disable ranges comparison

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "enabled": {
      "type": "boolean"
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "enabled"],
  "additionalProperties": false,
  "title": "Measure advanced ranges comparison enabled schema"
}

setMeasureAdvancedRangesComparisonFirstRangeEnd

Section titled “setMeasureAdvancedRangesComparisonFirstRangeEnd”

Advanced ranges first range end

Set first range end for ranges comparison

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "firstRangeEnd": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "const": "variable"
            },
            "variableName": {
              "type": "string"
            }
          },
          "required": ["type", "variableName"],
          "additionalProperties": false
        }
      ]
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "firstRangeEnd"],
  "additionalProperties": false,
  "title": "Measure advanced ranges first range end schema"
}

setMeasureAdvancedRangesComparisonFirstRangeStart

Section titled “setMeasureAdvancedRangesComparisonFirstRangeStart”

Advanced ranges first range start

Set first range start for ranges comparison

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "firstRangeStart": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "const": "variable"
            },
            "variableName": {
              "type": "string"
            }
          },
          "required": ["type", "variableName"],
          "additionalProperties": false
        }
      ]
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "firstRangeStart"],
  "additionalProperties": false,
  "title": "Measure advanced ranges first range start schema"
}

setMeasureAdvancedRangesComparisonSecondRangeEnd

Section titled “setMeasureAdvancedRangesComparisonSecondRangeEnd”

Advanced ranges second range end

Set second range end for ranges comparison

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "secondRangeEnd": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "const": "variable"
            },
            "variableName": {
              "type": "string"
            }
          },
          "required": ["type", "variableName"],
          "additionalProperties": false
        }
      ]
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "secondRangeEnd"],
  "additionalProperties": false,
  "title": "Measure advanced ranges second range end schema"
}

setMeasureAdvancedRangesComparisonSecondRangeStart

Section titled “setMeasureAdvancedRangesComparisonSecondRangeStart”

Advanced ranges second range start

Set second range start for ranges comparison

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "secondRangeStart": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "const": "variable"
            },
            "variableName": {
              "type": "string"
            }
          },
          "required": ["type", "variableName"],
          "additionalProperties": false
        }
      ]
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "secondRangeStart"],
  "additionalProperties": false,
  "title": "Measure advanced ranges second range start schema"
}

setMeasureAdvancedRangesComparisonType

Section titled “setMeasureAdvancedRangesComparisonType”

Advanced ranges comparison type

Set ranges comparison type

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "type": {
      "type": "string",
      "enum": ["absolute", "percentage"]
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "type"],
  "additionalProperties": false,
  "title": "Measure advanced ranges comparison type schema"
}

setMeasureAdvancedRankSortDirection

Section titled “setMeasureAdvancedRankSortDirection”

Advanced rank sort direction

Set rank sort direction for rank advanced calculation

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "rankSortDirection": {
      "type": "string",
      "enum": ["asc", "desc"]
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "rankSortDirection"],
  "additionalProperties": false,
  "title": "Measure advanced rank sort direction schema"
}

setMeasureAdvancedSortingOrder

Section titled “setMeasureAdvancedSortingOrder”

Advanced sorting order

Set sorting order used by advanced calculation

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "sortingOrder": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "sortDirection": {
            "type": "string",
            "enum": ["asc", "desc"]
          }
        },
        "required": ["id", "sortDirection"],
        "additionalProperties": false
      }
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "sortingOrder"],
  "additionalProperties": false,
  "title": "Measure advanced sorting order schema"
}

setMeasureAdvancedStandardDeviations

Section titled “setMeasureAdvancedStandardDeviations”

Advanced standard deviations

Set standard deviations for outliers aggregation

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "standardDeviations": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "const": "variable"
            },
            "variableName": {
              "type": "string"
            }
          },
          "required": ["type", "variableName"],
          "additionalProperties": false
        }
      ]
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "standardDeviations"],
  "additionalProperties": false,
  "title": "Measure advanced standard deviations schema"
}

setMeasureAdvancedWindowBegin

Section titled “setMeasureAdvancedWindowBegin”

Advanced periods before

Set periods before for moving calculation

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "windowBegin": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "const": "variable"
            },
            "variableName": {
              "type": "string"
            }
          },
          "required": ["type", "variableName"],
          "additionalProperties": false
        }
      ]
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "windowBegin"],
  "additionalProperties": false,
  "title": "Measure advanced window begin schema"
}

setMeasureAdvancedWindowEnd

Section titled “setMeasureAdvancedWindowEnd”

Advanced periods after

Set periods after for moving calculation

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 key",
      "type": "string",
      "enum": ["measures", "supportingMeasures"]
    },
    "advancedOperationKey": {
      "description": "Advanced operation key",
      "type": "string",
      "enum": ["advancedCalculation", "nestedCalculation"]
    },
    "windowEnd": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "const": "variable"
            },
            "variableName": {
              "type": "string"
            }
          },
          "required": ["type", "variableName"],
          "additionalProperties": false
        }
      ]
    }
  },
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "windowEnd"],
  "additionalProperties": false,
  "title": "Measure advanced window end 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"
}

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"
}

setNumberFontColor

Section titled “setNumberFontColor”

Number font color

Change the color of the main number display

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"
    }
  ],
  "description": "Font color (hex, with optional alpha)",
  "title": "Number font color schema"
}

setNumberFontFamily

Section titled “setNumberFontFamily”

Number font family

Change the font family for the main number display

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Number font family schema",
  "type": ["string", "null"]
}

setNumberFontSize

Section titled “setNumberFontSize”

Number font size

Adjust the font size of the main number display

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Number font size schema",
  "type": "number"
}

setNumberFontStyle

Section titled “setNumberFontStyle”

Number font style

Apply font styling to the main number

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "weight": {
      "description": "Font weight",
      "type": ["number", "null"]
    },
    "bold": {
      "description": "Bold font. Should take precedence over weight",
      "type": "boolean"
    },
    "italic": {
      "type": "boolean"
    },
    "underlined": {
      "type": "boolean"
    },
    "strikethrough": {
      "type": "boolean"
    },
    "fontFamily": {
      "type": ["string", "null"]
    },
    "fontSize": {
      "type": "number"
    },
    "fontColor": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
        },
        {
          "type": "null"
        }
      ],
      "description": "Font color (hex, with optional alpha)"
    }
  },
  "additionalProperties": false,
  "title": "Number font style schema"
}

setNumberFontWeight

Section titled “setNumberFontWeight”

Number font weight

Set the font weight of the main number display

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Font weight",
  "title": "Number font weight 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"
}

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
    }
  }
}

setVerticalAlign

Section titled “setVerticalAlign”

Vertical align

Set vertical alignment of the number

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Number vertical align schema",
  "type": "string",
  "enum": ["auto", "top", "middle", "bottom"]
}

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"
}

toggleMeasureByName

Section titled “toggleMeasureByName”

Toggle measure by name

Enable, disable, or toggle a 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 measure by name 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"
}