Run full or incremental aggregate builds.
POST /v1/aggregates-batch/catalogs/<catalog_ID>/models/<model_Id>?isFullBuild=<true|false>
You can use the aggregates-batch
endpoint of the AtScale engine API to trigger full or incremental builds for all aggregates of a deployed model. When running an incremental build, you can optionally specify grace period overrides for specific datasets in the model.
For in-depth instructions on using the engine API to run aggregate builds, see Rebuilding Aggregates Using the REST API.
Request
Path parameters
catalog_ID
: String, required. The ID of the catalog to run an aggregate build for.model_ID
: String, required. The ID of the model to run an aggregate build for.
Query parameters
isFullBuild
: Boolean, required. Determines whether the build is full (true
) or incremental (false
).
Header parameters
Authorization
: String, required. Your API token.
Body parameters
gracePeriodOverrides
: Array, optional. For incremental builds only. The datasets you want to provide grace period overrides for, and the new grace period values. For example:"factinternetsales": 30
Responses
201
Success.
batch
: Objectid
: UUIDcatalogId
: UUIDmodelId
: UUIDcreateDate
: Datetimestatus
: String. Possible values:done
,invalid
,new
,inprogress
,unreliable
,cancelled
,error
,success
,deleted
,running
,active
,failed
,pending
estimateTime
: NumberisFullBuild
: BooleanbatchType
: String. Possible values:aggregate_batch
success
: Boolean
400
Invalid request. For example: Invalid parameters, missing parameters.
401
Unauthorized. This error will occur if calling user is not authenticated.
404
Not found. The server cannot find the requested resource.
500
A server error occurred. Check the logs for more details.
503
Server unavailable.
Sample requests
Full build
curl -L 'https://<host>/v1/aggregates-batch/catalogs/<catalog_ID>/models/<model_Id>?isFullBuild=true' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"gracePeriodOverrides": {}
}'
Incremental build
curl -L 'https://<host>/v1/aggregates-batch/catalogs/<catalog_Id>/models/<model_ID>?isFullBuild=false' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
"gracePeriodOverrides": {
"factinternetsales": 30}
}'
Sample responses
Full build
{
"batch":{
"id":"<batch_Id>",
"catalogId":"<catalog_Id>",
"modelId":"<model_Id>",
"createDate":"2025-02-27T09:53:22.654Z",
"status":"new",
"estimateTime":1053,
"isFullBuild":true,
"batchType":"aggregate_batch"
},
"success":true
}
Incremental build
{
"batch":{
"id":"<batch_Id>",
"catalogId":"<catalog_Id>",
"modelId":"<model_Id>",
"createDate":"2025-02-27T10:56:50.807Z",
"status":"new",
"estimateTime":267,
"isFullBuild":false,
"batchType":"aggregate_batch"
},
"success":true
}