Aggregate Objects

This endpoint performs aggregation operations on objects in a bucket.

Aggregation Framework: Provides MongoDB-style aggregation operations:

• GROUP BY: Group objects by one or more fields
• Aggregations: COUNT, SUM, AVG, MIN, MAX, COUNT_DISTINCT, etc.
• Date Operations: Truncate or extract date parts for time-series analysis
• Filtering: Pre-aggregation filters (WHERE) and post-aggregation filters (HAVING)
• Sorting & Limiting: Control result ordering and size

Use Cases:

• Count objects by status or category
• Calculate daily/monthly upload statistics
• Analyze content distribution and trends
• Generate reports with multiple metrics

Note: This endpoint works with both MongoDB objects and vector store documents using the same interface. The system automatically selects the appropriate aggregation provider.

POST /v1/buckets/{bucket_identifier}/objects/aggregate

Aggregate Objects

cURL

curl --request POST \
  --url https://api.mixpeek.com/v1/buckets/{bucket_identifier}/objects/aggregate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <api-key>' \
  --data '
{
  "aggregations": [
    {
      "alias": "total",
      "function": "count"
    }
  ],
  "description": "Count objects by status",
  "group_by": [
    {
      "alias": "status",
      "field": "status"
    }
  ],
  "sort_by": "total",
  "sort_direction": "desc"
}
'

200

{
  "query_info": {
    "execution_time_ms": 45,
    "pipeline_stages": 5
  },
  "results": [
    {
      "group": {
        "status": "completed"
      },
      "metrics": {
        "total": 1523
      }
    },
    {
      "group": {
        "status": "pending"
      },
      "metrics": {
        "total": 87
      }
    }
  ],
  "total_groups": 2
}

Authorizations

Authorization · string · header · required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing, malformed, unknown, revoked, inactive or expired key returns 401; a key without the permission, scope or plan an operation needs returns 403.

X-Namespace · string · header · required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

Path Parameters

bucket_identifier · string · required

The unique identifier of the bucket.

Body

application/json

Keys this body does not declare are refused with 422 extra_forbidden naming the accepted keys (since 2026-11-02).

Aggregation configuration specifying grouping, metrics, and filters.

group_by · GroupByField · object[] · required

Fields to group results by. REQUIRED, at least one field. Can include field transformations (date_trunc, date_part). Results will have one row per unique combination of group_by values.

Minimum array length: 1

Show child attributes

aggregations · AggregationOperation · object[] · required

Aggregation operations to perform. REQUIRED, at least one operation. Each operation produces a calculated field in results. Can combine multiple functions (COUNT, SUM, AVG, etc.).

Minimum array length: 1

Show child attributes

filters · Filters · object | null

Pre-aggregation filters to apply to source data. OPTIONAL, filters data before grouping. Uses same syntax as standard query filters. Applied before GROUP BY.

Example:

{ "metadata.status": "active" }

having · HavingCondition · object[] | null

Post-aggregation filters to apply to results. OPTIONAL, filters groups after aggregation. Uses aggregation aliases as field names. Applied after GROUP BY and aggregation calculations.

Show child attributes

unwind · string | null

Array field to unwind before aggregation. OPTIONAL, creates one document per array element. Useful for aggregating over array contents. Example: 'blobs' to analyze each blob separately.

Example:

"blobs"

range_buckets · RangeBucket · object[] | null

Range-based bucketing for numeric fields. OPTIONAL, creates histogram-style buckets. Groups numeric values into defined ranges. Applied during grouping stage.

Show child attributes

sort_by · string | null

Field to sort results by. OPTIONAL, can be group_by field or aggregation alias. Defaults to no specific order. Use with sort_direction to control order.

Example:

"total_count"

sort_direction · string · default: desc

Sort direction. OPTIONAL, defaults to 'desc' (descending). Valid values: 'asc' (ascending), 'desc' (descending). Used with sort_by field.

Examples:

"asc"

"desc"

limit · integer | null

Maximum number of results to return. OPTIONAL, no limit if not specified. Applied after sorting. Useful for 'top N' queries.

Required range: x > 0

Example:

10

Response

200

application/json

Successful Response

Response containing object aggregation results.

Returns aggregated statistics grouped by specified fields.

results · AggregationResult · object[] · required

List of aggregation results, one per group.

Show child attributes

total_groups · integer · required

Total number of unique groups returned.

query_info · Query Info · object

Additional information about the query execution. May include pipeline stages, execution time, etc.