Get Database Aggregates

Lists saved Mongo aggregations for a schema.

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

This endpoint returns the database aggregates available in your project.

Lists saved Mongo aggregations for a schema

get

Authorizations

Bearer

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

SchemaIdstring · nullableRequired

Schema id whose saved aggregates to list, from get_database_schemas.

startingAfterstring · nullableOptional

Cursor token — fetch the page AFTER this item.

endingBeforestring · nullableOptional

Cursor token — fetch the page BEFORE this item.

pageSizeinteger · int32 · nullableOptional

Amount of records to return.

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

OK

application/json

get/{version}/database/aggregates

HTTPcURLJavaScriptPython

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

200

OK

{
  "responseStatus": {
    "isSuccess": true
  },
  "list": {
    "items": [],
    "hasMore": true,
    "hasPrevious": true,
    "startingAfter": "text",
    "endingBefore": "text"
  }
}

In the dashboard

Manage this visually in Norbix Cloud — see Database.

Use it from code

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