Get Calculated Measures from Workbook
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API retrieves calculated measures from a Workbook.
Method: POST
Request URL: {kyvos-url}/rest/v2/workbooks/{name-or-id}/calculated-measures
Authorization
API Key: sessionid
This method authenticates requests using a session ID which acts like an API key.
BasicAuth: HTTP Authorization Scheme
This method authenticates requests using a username and password sent in the HTTP Authorization header.
Headers
Header Name | Type | Description | Possible Values |
|---|---|---|---|
Content-Type (Required) | String | Specifies the media type of the request body. |
|
sessionid | String | The session ID is the token received from the login API. Note: Session ID is required for token-based authentication. | – |
Path Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
name-or-id (Required) | String | Name or ID of the Workbook from which calculated measures need to be retrieved. Note: If the Workbook name is provided, then either folderName or folderId must also be provided. | – |
Query Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
by | String | Specifies whether the name-or-id parameter should be interpreted as a Workbook name or Workbook ID. If by=name, provide the Workbook name in the name-or-id parameter. If by=id, provide the Workbook ID in the name-or-id parameter. The default value is name. | – |
folderName | String | Name of the folder containing the Workbook. If the Workbook is present in the root directory, specify [Root]. Note: If neither folderName nor folderId is provided, the Workbook will be treated as a root-level entity by default. | – |
folderId | String | ID of the folder containing the Workbook. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
measureNames | String | Comma-separated names of the measures to retrieve. If this value is not provided, all calculated measures are returned. | – |
Responses
200 Success
{
"measures": [
{
"isKeyElement": false,
"dataField": {
"queryName": "",
"content": "",
"queryId": ""
},
"color": "",
"materialize": "",
"adjustmentType": "NEGATIVE",
"description": "",
"type": "STANDARD",
"restrict": false,
"cubeObject": {
"name": "Order Date",
"id": "16032701190267127072016117438809",
"folderName": "Kyvos_DataAccuracyCubes"
},
"isBoundaryDistCount": false,
"nonEmptyMeasures": "MEASURE_11",
"measureGroup": "CalculatedMeasureGroup",
"id": "MEASURE_623120",
"formatType": "2",
"isAccessible": true,
"expression": {
"nonEmptyBehavior": "BY_MEASURE",
"content": "[Measures].[AUD_RT]"
},
"sqlColumn": {
"displayName": "",
"name": "CalculatedMeasure"
},
"dataType": "NUMBER",
"summaryFunction": "",
"dictionaryType": "INDEX",
"format": {
"useDefault": "0",
"content": "#,##0.00"
},
"isVisible": true,
"minOnMaxOnDataField": {
"queryName": "",
"content": "",
"queryId": ""
},
"tags": "",
"props": {
"hasParameterInExpression": false
},
"isDefault": false,
"unit": "",
"uniqueName": "MEASURE_623120",
"isAdjustment": false,
"isVisibleConversational": true,
"name": "CalculatedMeasure",
"subType": "",
"displayFolder": "",
"solveOrder": 0
},
{
"isKeyElement": false,
"dataField": {
"queryName": "",
"content": "",
"queryId": ""
},
"color": "",
"materialize": "",
"adjustmentType": "NEGATIVE",
"description": "",
"type": "STANDARD",
"restrict": false,
"cubeObject": {
"name": "Order Date",
"id": "16032701190267127072016117438809",
"folderName": "Kyvos_DataAccuracyCubes"
},
"isBoundaryDistCount": false,
"nonEmptyMeasures": "MEASURE_11",
"measureGroup": "CalculatedMeasureGroup",
"id": "MEASURE_340272",
"formatType": "2",
"isAccessible": true,
"expression": {
"nonEmptyBehavior": "BY_MEASURE",
"content": "[Measures].[ConstantValue]"
},
"sqlColumn": {
"displayName": "",
"name": "CalculatedMeasure_1"
},
"dataType": "NUMBER",
"summaryFunction": "",
"dictionaryType": "INDEX",
"format": {
"useDefault": "0",
"content": "#,##0.00"
},
"isVisible": true,
"minOnMaxOnDataField": {
"queryName": "",
"content": "",
"queryId": ""
},
"tags": "",
"props": {
"hasParameterInExpression": false
},
"isDefault": false,
"unit": "",
"uniqueName": "MEASURE_340272",
"isAdjustment": false,
"isVisibleConversational": true,
"name": "CalculatedMeasure_1",
"subType": "",
"displayFolder": "",
"solveOrder": 0
}
]
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |