Sign in

v1

latestOpenAPI 3.1.02026-08-069158174.8 KB
CRM Service Calls
CRM Aggregate

Aggregate Orders

Aggregate orders by group-by fields — ideal for dashboards, charts, and analytics.

Use this endpoint to build order distribution charts, fulfillment status views, or revenue breakdowns by order type.

Request Body (AggregateRequest): Same as leads/aggregate.

Examples:

  • Orders by stage: {"group_by_fields": ["stage"]}
  • Orders by type with amount: {"group_by_fields": ["order_type"], "aggregate_field": "total_amount"}
post/crm/orders/aggregate

Request body

group_by_fieldsstring[] required

Fields to group by, e.g. ["lead_status"], ["stage", "marketing_source"]

aggregate_fieldstring nullable

Numeric field to aggregate, e.g. "value_of_sale", "estimated_budget"

match_filter_dictstring nullable

JSON-stringified MongoDB filter to narrow the dataset before aggregation

sort_dictstring nullable

JSON-stringified sort criteria, e.g. {"count": -1}

page_sizeinteger

Maximum number of groups to return

page_numinteger

Page number (1-indexed)

Response

Successful Response

total_groupsinteger

Total number of groups returned

aggregate_fieldstring nullable

The numeric field that was aggregated

group_by_fieldsstring[]

Fields that were grouped by