Skip to main content

Obtain details about aggregate instances. You can query by definition ID, catalog ID, model ID, status, batch ID, table name, start time, and end time.

GET 
/v1/aggregates/instances

Obtain details about aggregate instances. You can query by definition ID, catalog ID, model ID, status, batch ID, table name, start time, and end time.

Request​

Query Parameters

    definitionId string
    catalogId string
    modelId string
    status string

    Possible values: [active, invalid, pending, deleted]

    batchId string
    tableName string
    startTime string
    endTime string
    page number

    Page number to retrieve (1-based). Defaults to 1.

    size number

    Maximum number of instances to return per page. Defaults to 10.

Header Parameters

    Authorization string

Responses​

Array with aggregate instances

Schema

    data

    object[]

    required

  • Array [

    • id uuidrequired

    Possible values: non-empty

    status stringrequired

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

    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

  • ]

    • total number
    size numberrequired
    page numberrequired
    offset numberrequired
Loading...