Magidoc

getOpportunityPipelineSummary
Query

Breaks the opportunities matching the filters into forecast buckets (open, commit, most likely, best case, closed won, closed lost), each with a count and summed amount. Use it for a pipeline or forecast overview; getOpportunityStats returns only overall totals.

Access: workspace members with CRM access.

Arguments

#

workspaceId

ID !
Non-null

searchParams

SearchParams

accountId

ID

accountIds

[ID !]

ownerId

ID

ownerIds

[ID !]

excludeOwnerIds

[ID !]

Exclude opportunities owned by these users.

ownerIdIsNull

Boolean

pipelineIds

[ID !]

excludeStageIds

[ID !]

Exclude opportunities in these stages. Matches the stage id, or the stage key on records without one.

stageIds

[ID !]

stageKeys

[String !]

stageState

OpportunityStageState

excludeStageStates

[OpportunityStageState !]

Exclude opportunities in these open/closed states.

isWon

Boolean

isLost

Boolean

Only deals whose stage outcome is explicitly lost (true), or every other deal (false). Dormant and other no-outcome closed deals are not lost; isWon: false still includes them.

forecastCategories

[OpportunityForecastCategory !]

excludeForecastCategories

[OpportunityForecastCategory !]

Exclude opportunities in these forecast categories.

types

[OpportunityType !]

excludeTypes

[OpportunityType !]

typeIds

[String !]

Business type option ids from the workspace's business type setting (settings.crmFieldOptions.opportunityType).

excludeTypeIds

[String !]

Exclude opportunities with these business type option ids.

minAmount

Float

maxAmount

Float

closeDateAfter

Date

closeDateBefore

Date

includeUnownedRecords

Boolean

Include opportunities with no owner, on its own or alongside ownerIds. Insights uses this for its Unassigned option.

Response

#

Returns OpportunityPipelineSummary !.

Example

#