Add and Update Calculated Measures

This documentation is for Kyvos 2026.5.x. To view documentation for other Kyvos versions, click here.

This documentation is for Kyvos 2026.5.x. To view documentation for other Kyvos versions, click here.

Resources

Below is an example of JSON structure which can be used as a reference for the measuresJson parameter in the request body.

{
    "measureName1":{
        "expression":"[Measures].[Amount]*[Measure].[ID]",
        "description":"description1",
        "groupName":"MeasureGroup",
        "groupDescription":"groupDescription1",
        "solveOrder":"1",
        "formatType":"Number",
        "format":"#,##0.00",
        "isVisible":false,
        "nonEmptyBehaviour":"BY_MEASURE",
        "nonEmptyMeasures":"ID"
    }
}

Additional Details of JSON Example

Format Type

The formatType field can be provided either as a string or as a numerical value based on the following mapping:

2 – Number
3 – Currency
4 – Date
5 – Time
6 – Percentage
7 – Scientific
9 – Custom
10 – Duration

Non-Empty Behaviour

The nonEmptyBehaviour field determines how the system evaluates whether a calculated measure is empty. Supported values include:

BY_EXPRESSION
The expression itself is evaluated to determine if the calculated measure is empty.
BY_MEASURE
The calculated measure is treated as empty if all the specified measures are empty.
BY_MEASURE_THEN_EXPRESSION
The calculated measure is treated as empty if all specified measures are empty, or if the evaluated expression is empty.