165a6d16a9a0
latestOpenAPI 3.1.02026-08-069158174.8 KBCRM Service Calls
CRM Aggregate
Aggregate Deals
Aggregate deals/opportunities by group-by fields — ideal for dashboards, charts, and analytics.
Use this endpoint to build pipeline visualizations, revenue forecasts, and deal-stage funnels. Grouping by stage with aggregate_field: "value_of_sale" gives you a weighted pipeline view suitable for bar/funnel charts.
Request Body (AggregateRequest): Same as leads/aggregate.
Examples:
- Pipeline by stage: {"group_by_fields": ["stage"]}
- Pipeline value by stage: {"group_by_fields": ["stage"], "aggregate_field": "value_of_sale"}
- Deals by source: {"group_by_fields": ["marketing_source"]}
post/crm/deals/aggregate
Request body
Response
Successful Response