Aggregate

Execute MongoDb aggregate over your database

When you have a complex query where you need to link more than several collections together, and when you need to calculate, aggregate, sum up, and group the data, you can write aggregate and execute it from the API.

Execute MongoDb aggregate over your database.

When you have complex query where you need link more than several collections together, and when you need calculate, aggregate, sum up, group the data, then you can write aggregate and execute it from the API. https://docs.codemash.io/api/database/collections/aggregate

get

/{version}/db/{CollectionName}/aggregate/{id}

Authorizations

Path parameters

Idanyrequired

Id of an aggregate

CollectionNameanyrequired

Collection name - unique, lowercased, collection name without whitespace. E.g., if your collection title you have entered in the CodeMash dashboard is "Business Trips" then collection name would be "business-trips".

versionanyrequired

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

Header parameters

Acceptanyrequired

Accept Header

X-CM-Clusterany

API key of your cluster. Can be passed in a header as X-CM-Cluster.

X-CM-ProjectIdanyrequired

ID of your project. Can be passed in a header as X-CM-ProjectId.

CultureCodeany

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

Body

Other propertiesstring

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.codemash.io//{version}/db/{CollectionName}/aggregate/{id}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "ANY_ADDITIONAL_PROPERTY": "text"
  }'

200

200

{
  "response_status": {
    "error_code": "text",
    "message": "text",
    "stack_trace": "text",
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "errors": [
      {
        "error_code": "text",
        "field_name": "text",
        "message": "text",
        "meta": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ]
  },
  "result": "text"
}

Success

Execute MongoDb aggregate over your database.

When you have complex query where you need link more than several collections together, and when you need calculate, aggregate, sum up, group the data, then you can write aggregate and execute it from the API. https://docs.codemash.io/api/database/collections/aggregate

post

/{version}/db/{CollectionName}/aggregate/{id}

Authorizations

Path parameters

Idanyrequired

Id of an aggregate

CollectionNameanyrequired

Collection name - unique, lowercased, collection name without whitespace. E.g., if your collection title you have entered in the CodeMash dashboard is "Business Trips" then collection name would be "business-trips".

versionanyrequired

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

Header parameters

Acceptanyrequired

Accept Header

X-CM-Clusterany

API key of your cluster. Can be passed in a header as X-CM-Cluster.

X-CM-ProjectIdanyrequired

ID of your project. Can be passed in a header as X-CM-ProjectId.

CultureCodeany

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

Body

Other propertiesstring

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.codemash.io//{version}/db/{CollectionName}/aggregate/{id}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "ANY_ADDITIONAL_PROPERTY": "text"
  }'

200

200

{
  "response_status": {
    "error_code": "text",
    "message": "text",
    "stack_trace": "text",
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "errors": [
      {
        "error_code": "text",
        "field_name": "text",
        "message": "text",
        "meta": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ]
  },
  "result": "text"
}

Success

.NET

var client = new CodeMashClient(apiKey, projectId);
var service = new CodeMashRepository<Person>(client);

var aggregateOptions = new AggregateOptions {
    Tokens = new Dictionary<string, string> { { "name", "John" } }
}

var aggregateResult = await service.AggregateAsync<PersonProjection>(
    Guid.Parse("{AGGREGATE_ID}"),
    aggregateOptions
);

Check the docs on aggregation.