Pipeline summary
get_pipeline_summaryAggregate roll-up of the workspace's opportunities and revenue. Returns: opportunities broken down by type AND stage; the open pipeline segmented by lens (pipeline_by_lens), where lens membership is derived from each stage's role, not its label; each stage with its role (unqualified | qualifying | active | commit | won | lost) plus sales_boundary_stage (the first 'active'-role stage — the open-pipeline boundary); a revenue roll-up (total ARR, customer count, at-risk count); renewals due in the next 90 days (count + ARR at risk computed over EVERY renewal due, plus a list of up to 500 with coverage {status complete|truncated, returned, total} and truncated saying whether the list is a sample); and accounts in the explicit at-risk lifecycle stage. Optionally scope to ONE pipeline with pipeline_key (or pipeline_id): this filters ONLY the opportunity breakdowns (stages, pipeline_by_lens, pipeline_by_type_and_stage) to that pipeline — omit both for the workspace default pipeline + unassigned deals. The revenue roll-up, renewals, and at-risk accounts are always workspace-wide regardless of the pipeline filter. The additive forecast block carries per-person rows and the reporting-tree rollup, separate currencies, targets, human calls, and the exact deal ids behind every cell. Nothing predicts.
When to use: The Revenue sales pipeline — forecast, stage mix, renewals, ARR. It assumes a revenue pipeline, so it's only for workspaces that run a sales motion with real opportunities. Don't reach for it to answer a vague 'show me my data', and never before a workspace has chosen its motion — it has nothing to show then. Pass pipeline_key to scope the stage/type breakdowns to one named pipeline (revenue, renewals, and at-risk stay workspace-wide). The renewals-due count and ARR at risk cover every renewal; the list itself is capped at 500 and says so in its coverage.
Example: Give me a pipeline summary.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pipeline_id | No | Scope the opportunity breakdowns to this pipeline by id (uuid). Prefer pipeline_key. | |
| pipeline_key | No | Scope the opportunity breakdowns to this pipeline by its stable KEY (see the `pipelines` section / describe_schema). Omit both for the default pipeline + unassigned deals (today's behavior). pipeline_id wins if both are given. | |
| forecast_period | No | Calendar forecast period in the workspace timezone; defaults to quarter. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | ||
| empty | No | ||
| stages | No | ||
| revenue | No | ||
| forecast | No | ||
| framework | No | ||
| pipeline_by_lens | No | ||
| total_opportunities | No | ||
| sales_boundary_stage | No | ||
| renewals_due_next_90_days | No | ||
| pipeline_by_type_and_stage | No |