Save Aggregates
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API saves aggregate definitions for a Semantic Model. It allows you to add or update aggregate information associated with a Semantic Model.
Method: POST
Request URL: {kyvos-url}/rest/v2/semantic-models/{name-or-id}/aggregates
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 Semantic Model for which aggregates are to be saved. | – |
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 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. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
aggregatesJson (Required) | String | JSON object specifying aggregate definitions and strategy information used to add or update aggregates for the Semantic Model. Note: An example JSON is provided under the Resources section below. | – |
Responses
200 Success
{
"res": {
"code": 0,
"entityId": "SMODEL_OBJECT_17748761273700127033075188430671",
"message": "Successfully added semantic model aggregates",
"extMessage": ""
}
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
412 | Precondition failed. Required parameter is missing. |
500 | Internal Server Error |
Resources
Below is an example of JSON structure which can be used as a reference for the aggregatesJson parameter in the request body.
{
"entities":[
{
"aggregationStrategy":{
"queryDriven":{
"orientationInfo":"1"
},
"type":"QUERY_DRIVEN"
},
"subType":"CUBE",
"id":"SMODEL_OBJECT_17748761273700127033075188430671",
"type":"ANALYTICAL",
"aggregateInfos":{
"aggregateInfo":""
}
}
]
}