Get Database Aggregate

Get saved Mongo aggregation by id.

An aggregate is a saved MongoDB aggregation pipeline you can run to compute, group, and summarise data.

This endpoint returns a single database aggregate by id.

The answer carries JoinedCollections — the collections the saved pipeline joins, stored when it was saved (empty for a pipeline without joins; null for one saved before 2026-10-05 — it is filled on the next save).

Get saved Mongo aggregation by id

get

Authorizations

HTTPRequired

JWT Bearer Authorization

Path parameters

versionstring · nullableRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

Query parameters

Idstring · nullableRequired

Aggregate id from get_database_aggregates.

SchemaIdstring · nullableRequired

Schema id that owns this aggregate, from get_database_schemas.

Header parameters

norbix-project-idstring · nullableRequired

ID of your project. Can be passed in a header as norbix-project-id.

norbix-envstring · nullableOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

CultureCodestring · nullableOptional

Specify culture code when your response from the API should be localised. E.g.: en

TimeZoneIdstring · nullableOptional

TimeZone

CorrelationIdstring · nullableOptional

CorrelationId for each request

Responses

200

Success

application/json

GetDatabaseAggregateResponse

get/{version}/database/aggregates/{Id}

GET /{version}/database/aggregates/{Id}?Id=text&SchemaId=text HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
norbix-project-id: text
Accept: */*

200

Success

{
  "item": {
    "viewId": "text",
    "displayName": "text",
    "description": "text",
    "schemaViewId": "text",
    "pipeline": "text",
    "joinedCollections": []
  },
  "responseStatus": {
    "isSuccess": true
  }
}

In Cloud

Manage this visually in Cloud — see Database.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Get Database Aggregate in the SDK reference, with examples in every language.