Get Aggregate Instance Details
GET/aggregates/orgId/:orgId/instances
Obtain details about aggregate instances. You can query by definition ID, project ID, cube ID, status, batch ID, table name, start time, and end time.
Request
Path Parameters
ID of the organization for which you want to obtain aggregate instance details.
Query Parameters
ID of the aggregate definition
ID of the project for which you need instances
ID of the cube for which you need instances
Status of the definitions you need. Value should be 'active', 'invalid', 'deleted', or 'pending'.
Batch ID.
Table name.
Start time when the instance was materialized. The format is like this: '2023-07-03T09:43:16'
End time when the instance was materialized. The format is like this: '2023-07-03T09:43:17'
Responses
- 200
- 400
- 401
- 404
- 500
Success.
- application/json
- Schema
- Example (from schema)
- Example
Schema
any
{
"status": {
"code": 0,
"message": "200 OK"
},
"responseCreated": "2023-07-03T12:49:03.463342Z",
"response": {
"data": [
{
"id": "e0bc4492-8ce8-495d-a227-254f6dab834d",
"status": "active",
"message": "Normal aggregate activated",
"table_name": "as_agg_e0bc4492_uda_color",
"table_schema": "as_adventure",
"stats": {
"materialization_start_time": "2023-07-03T09:43:16.840573Z",
"materialization_end_time": "2023-07-03T09:43:17.077188Z",
"build_duration": 236,
"number_of_rows": 8
},
"build_query_id": "0a0c1e36-9065-4357-bf73-81b5789c38e3",
"project_id": "8d42bf05-2571-437a-586c-9b60862b5936",
"cube_id": "d623656f-9a54-4e13-49b6-dabc108128f3",
"definition_id": "c197f3b9-7f4b-4f0a-84b4-def0159a53d3",
"connection_id": "con1"
},
{
"id": "d2c12d26-2dfc-4a35-9d57-32946ac6108e",
"status": "active",
"message": "Normal aggregate activated",
"table_name": "as_agg_d2c12d26_shpdcstmwkofmn",
"table_schema": "as_adventure",
"stats": {
"materialization_start_time": "2023-07-03T08:28:18.740059Z",
"materialization_end_time": "2023-07-03T08:28:18.826658Z",
"build_duration": 86,
"number_of_rows": 6
},
"build_query_id": "ed7b17be-ed4c-47bb-974c-5e6fb92db00b",
"project_id": "8d42bf05-2571-437a-586c-9b60862b5936",
"cube_id": "d623656f-9a54-4e13-49b6-dabc108128f3",
"definition_id": "52a54b83-d27e-4b5a-bc41-872db945a4f7",
"connection_id": "con1"
}
],
"limit": 10,
"offset": 0,
"force_pull": false
}
}
{
"status": {
"code": 0,
"message": "200 OK"
},
"responseCreated": "2023-07-03T12:49:03.463342Z",
"response": {
"data": [
{
"id": "e0bc4492-8ce8-495d-a227-254f6dab834d",
"status": "active",
"message": "Normal aggregate activated",
"table_name": "as_agg_e0bc4492_uda_color",
"table_schema": "as_adventure",
"stats": {
"materialization_start_time": "2023-07-03T09:43:16.840573Z",
"materialization_end_time": "2023-07-03T09:43:17.077188Z",
"build_duration": 236,
"number_of_rows": 8
},
"build_query_id": "0a0c1e36-9065-4357-bf73-81b5789c38e3",
"project_id": "8d42bf05-2571-437a-586c-9b60862b5936",
"cube_id": "d623656f-9a54-4e13-49b6-dabc108128f3",
"definition_id": "c197f3b9-7f4b-4f0a-84b4-def0159a53d3",
"connection_id": "con1"
},
{
"id": "d2c12d26-2dfc-4a35-9d57-32946ac6108e",
"status": "active",
"message": "Normal aggregate activated",
"table_name": "as_agg_d2c12d26_shpdcstmwkofmn",
"table_schema": "as_adventure",
"stats": {
"materialization_start_time": "2023-07-03T08:28:18.740059Z",
"materialization_end_time": "2023-07-03T08:28:18.826658Z",
"build_duration": 86,
"number_of_rows": 6
},
"build_query_id": "ed7b17be-ed4c-47bb-974c-5e6fb92db00b",
"project_id": "8d42bf05-2571-437a-586c-9b60862b5936",
"cube_id": "d623656f-9a54-4e13-49b6-dabc108128f3",
"definition_id": "52a54b83-d27e-4b5a-bc41-872db945a4f7",
"connection_id": "con1"
}
],
"limit": 10,
"offset": 0,
"force_pull": false
}
}
Invalid request for example: Invalid parameters, missing parameters.
Unauthorized. This error will occur if calling user does not have access right for the API.
Unauthorized. This error will occur if calling user does not have access right for the API.
A server error occurred. Check the logs for more details.