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

id string
catalogId string
catalog string
modelId string
status string

Possible values: [active, invalid, pending]

subtype string

Possible values: [demand_defined, prediction_defined, manual, hinted]

Header Parameters

Authorization string

Responses

200

Array with aggregate definitions

application/json

Schema

Schema

data

object[]

required

Array [

id uuidrequired

Possible values: non-empty

name stringrequired

Possible values: non-empty

type stringrequired

Possible values: [system_defined, user_defined]

subtype stringrequired

Possible values: non-empty

incremental booleanrequired

catalogId stringrequired

Possible values: non-empty

catalogCaption stringrequired

modelId stringrequired

Possible values: non-empty

connectionId stringrequired

Possible values: non-empty

importedAt string

systemDefinedWithDistinctCount booleanrequired

promoted booleanrequired

latestInstance

object

required

id uuidrequired

Possible values: non-empty

status stringrequired

Possible values: [done, invalid, new, inprogress, unreliable, cancelled, error, success, deleted, running, active, failed, pending]

message string

tableName string

tableSchema string

batchId uuid

stats

object

required

materializationStartTime stringrequired

Possible values: non-empty

materializationEndTime string

buildDuration numberrequired

numberOfRows number

buildQueryId uuid

catalogId uuidrequired

Possible values: non-empty

modelId uuidrequired

Possible values: non-empty

definitionId uuidrequired

Possible values: non-empty

connectionId stringrequired

Possible values: non-empty

activeInstance

object

required

id uuidrequired

Possible values: non-empty

status stringrequired

Possible values: [done, invalid, new, inprogress, unreliable, cancelled, error, success, deleted, running, active, failed, pending]

message string

tableName string

tableSchema string

batchId uuid

stats

object

required

materializationStartTime stringrequired

Possible values: non-empty

materializationEndTime string

buildDuration numberrequired

numberOfRows number

buildQueryId uuid

catalogId uuidrequired

Possible values: non-empty

modelId uuidrequired

Possible values: non-empty

definitionId uuidrequired

Possible values: non-empty

connectionId stringrequired

Possible values: non-empty

stats

object

required

createdAt stringrequired

Possible values: non-empty

averageBuildDuration number

queryUtilization numberrequired

mostRecentQuery string

attributes

object[]

required

Array [

name stringrequired

Possible values: non-empty

type stringrequired

Possible values: non-empty

partitioned booleanrequired

]

]

Example (from schema)

{
  "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
        }
      ]
    }
  ]
}

400

Invalid request for example: Invalid parameters, missing parameters.

401

Unauthorized. This error will occur if calling user is not authenticated.

403

Forbidden. This error will occur if calling user does not have access right for the API.

404

Not found. The server cannot find the requested resource.

500

A server error occurred. Check the logs for more details.

Loading...