Obtain details about aggregate definitions. You can query by ID, catalog, catalog id, model ID, status, and subtype.
GET/v1/public/aggregates
Obtain details about aggregate definitions. You can query by ID, catalog, catalog id, model ID, status, and subtype.
Request
Query Parameters
Possible values: [active
, invalid
, pending
]
Possible values: [demand_defined
, prediction_defined
, manual
, hinted
]
Header Parameters
Responses
- 200
- 400
- 401
- 403
- 404
- 500
Array with aggregate definitions
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
data
object[]
required
Possible values: non-empty
Possible values: non-empty
Possible values: [system_defined
, user_defined
]
Possible values: non-empty
Possible values: non-empty
Possible values: non-empty
Possible values: non-empty
latestInstance
object
required
Possible values: non-empty
Possible values: [done
, invalid
, new
, inprogress
, unreliable
, cancelled
, error
, success
, deleted
, running
, active
, failed
, pending
]
stats
object
required
Possible values: non-empty
Possible values: non-empty
Possible values: non-empty
Possible values: non-empty
Possible values: non-empty
activeInstance
object
required
Possible values: non-empty
Possible values: [done
, invalid
, new
, inprogress
, unreliable
, cancelled
, error
, success
, deleted
, running
, active
, failed
, pending
]
stats
object
required
Possible values: non-empty
Possible values: non-empty
Possible values: non-empty
Possible values: non-empty
Possible values: non-empty
stats
object
required
Possible values: non-empty
attributes
object[]
required
Possible values: non-empty
Possible values: non-empty
{
"data": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"type": "system_defined",
"subtype": "string",
"incremental": true,
"catalogId": "string",
"catalogCaption": "string",
"modelId": "string",
"connectionId": "string",
"importedAt": "string",
"systemDefinedWithDistinctCount": true,
"promoted": true,
"latestInstance": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "done",
"message": "string",
"tableName": "string",
"tableSchema": "string",
"batchId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"stats": {
"materializationStartTime": "string",
"materializationEndTime": "string",
"buildDuration": 0,
"numberOfRows": 0
},
"buildQueryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"catalogId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"definitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"connectionId": "string"
},
"activeInstance": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "done",
"message": "string",
"tableName": "string",
"tableSchema": "string",
"batchId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"stats": {
"materializationStartTime": "string",
"materializationEndTime": "string",
"buildDuration": 0,
"numberOfRows": 0
},
"buildQueryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"catalogId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"definitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"connectionId": "string"
},
"stats": {
"createdAt": "string",
"averageBuildDuration": 0,
"queryUtilization": 0,
"mostRecentQuery": "string"
},
"attributes": [
{
"name": "string",
"type": "string",
"partitioned": true
}
]
}
]
}
Invalid request for example: Invalid parameters, missing parameters.
Unauthorized. This error will occur if calling user is not authenticated.
Forbidden. This error will occur if calling user does not have access right for the API.
Not found. The server cannot find the requested resource.
A server error occurred. Check the logs for more details.