Get Calculated Measures
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 Semantic Model.
Method: POST
Request URL: {kyvos-url}/rest/v2/semantic-models/{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 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 Semantic Model from which calculated measures are to be retrieved. Note: If the Semantic Model name is provided, 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 Semantic Model name or a Semantic Model ID. If by=name, provide the Semantic Model name in the name-or-id parameter. If by=id, provide the Semantic Model ID in the name-or-id parameter. The default value is name. | – |
folderName | String | Name of the folder containing the Semantic Model. If the Semantic Model is present in the root directory, specify [Root]. Note: If neither folderName nor folderId is provided, the Semantic Model is treated as a root-level entity by default. | – |
folderId | String | ID of the folder containing the Semantic Model. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
measureName | String | Comma-separated list of measure names to retrieve. If this parameter is not provided, all calculated measures are retrieved. | – |
Responses
200 Success
{
"measures":[
{
"isKeyElement":false,
"dataField":{
"queryName":"",
"content":"",
"queryId":""
},
"color":"",
"materialize":"",
"adjustmentType":"NEGATIVE",
"description":"",
"type":"STANDARD",
"restrict":false,
"isBoundaryDistCount":false,
"nonEmptyMeasures":"MEASURE_11",
"id":"MEASURE_931909",
"formatType":"2",
"isAccessible":true,
"expression":{
"nonEmptyBehavior":"BY_MEASURE",
"content":"[Measures].[Average Sales],DYNAMIC_FORMAT=\"0.00\""
},
"dataType":"NUMBER",
"summaryFunction":"",
"dictionaryType":"INDEX",
"format":{
"useDefault":"0",
"content":"#,##0.00"
},
"isVisible":true,
"minOnMaxOnDataField":{
"queryName":"",
"content":"",
"queryId":""
},
"tags":"",
"isDefault":false,
"unit":"",
"uniqueName":"MEASURE_931909",
"isAdjustment":false,
"isVisibleConversational":true,
"name":"DynamicFormat",
"subType":"",
"displayFolder":"",
"solveOrder":0
}
]
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |