Review Pipeline History
get_pipeline_historyExplain what grew or shrank the pipeline, which deals caused the change, and how deals moved between stages. Return pipeline history for one requested date range, including the supported waterfall, stage-transition, and deal-change views. Calendar grouping can include earlier dates; use day for exact date ranges and check scope.date_basis.range for evidence dates. For comparisons, call once per range with identical non-date arguments; align by explicit ranges and returned order, and treat unavailable history as missing, not zero.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| columns | No | Optional fields; omission uses view defaults. For deal_changes, movement_type identifies the fact. assigned_to_owner means unassigned-to-assigned or entering owner/team scope; assigned_from_owner means assigned-to-unassigned or leaving scope; owner_changed is in-scope reassignment. amount is the ending deal_value_property value. Concurrent value and owner changes produce two fact rows. | |
| group_by | Yes | Historical grouping. Limits: 120 day, 208 week, 60 month, or 40 quarter periods. | |
| team_ids | No | Exclusive selector: non-empty exact team IDs, expanded to active owners. Use instead of owner_scope or owner_ids. | |
| owner_ids | No | Exclusive selector: non-empty exact IDs from the owners catalog. Use instead of owner_scope or team_ids. | |
| page_size | No | ||
| date_range | Yes | Required requested date range. Week/month/quarter grouping starts at the calendar-period boundary; use day for exact dates. Evidence dates are returned in scope.date_basis.range. Bounded to 120 day, 208 week, 60 month, or 40 quarter periods for the selected grouping. | |
| end_stages | No | ||
| segment_by | No | Optional current/latest deal-health segmentation for history_view=deal_changes. | |
| owner_scope | No | Exclusive selector: all owners or current authenticated user. Omitting all three owner selectors defaults to all workspace owners. | |
| amount_range | No | Inclusive configured Deal-value range. | |
| history_view | No | For what changed or why pipeline grew or shrank, start with waterfall. Use stage_transitions for stage-flow causes and deal_changes for supporting deals. snapshot shows state, not change drivers. | snapshot |
| start_stages | No | ||
| segment_value | No | ||
| group_page_size | No | ||
| pipeline_stages | No | ||
| movement_direction | No | Movement direction filter for stage_transitions or deal_changes. Use pipeline_changed for moves between pipelines and won or lost for historical outcomes. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| kind | Yes | ||
| tool | Yes | ||
| summary | Yes | ||
| result_id | No | ||
| limitations | No |