incrementalForecastingSummary

Retrieves the Incremental Forecasting summary (the Beam table): one row per channel segment for your latest model run, covering saturation point, headroom, rolling 7/14/30-day spend and target, trailing totals, and the segment dimensions.

Currency defaults to EUR

Saturation curve data is modelled and stored in EUR. By default values are returned in EUR; pass currency to convert (using the single exchange rate configured for your account — these rows are not dated, so no per-day spot rate applies). Spend-denominated fields (saturation point, average and total spend) always convert. Targets convert only for revenue goals (ROAS, New ROAS); conversion-count targets (CPP, CAC) stay native. Headroom is unitless and is never converted.

incrementalForecastingSummary(
  clientId: ID!
  currency: Currency
  market: String
  channelSegment: String
  targetType: SaturationCurveTargetType
  includeAmazonData: Boolean = false
  removeSalesPeriods: Boolean
  pagination: PaginationInput
): IncrementalForecastingSummaryResponse!

Arguments

incrementalForecastingSummary.clientId ● ID! non-null scalar common-objects

The unique identifier for your client account.

incrementalForecastingSummary.currency ● Currency enum common-objects

ISO 4217 currency for monetary fields. Defaults to EUR (no conversion). Other currencies must be configured for your account; spend converts always, revenue targets convert, conversion-count targets stay native.

incrementalForecastingSummary.market ● String scalar common-objects

Geographic market to filter by (case-insensitive), e.g. "UK". Omit for all markets.

incrementalForecastingSummary.channelSegment ● String scalar common-objects

Channel segment label to filter by (case-insensitive). Omit for all segments.

incrementalForecastingSummary.targetType ● SaturationCurveTargetType enum incremental-forecasting

Model target type to filter by. Omit for all target types.

incrementalForecastingSummary.includeAmazonData ● Boolean scalar common-objects

When true, returns the model run that includes Amazon sales data. Default: false.

incrementalForecastingSummary.removeSalesPeriods ● Boolean scalar common-objects

Optional variant filter. Omit (default) to return the latest run for each segment regardless of this setting. Set true/false to pin the sales-periods-removed or sales-periods-retained variant respectively.

incrementalForecastingSummary.pagination ● PaginationInput input common-objects

Pagination settings

Type

IncrementalForecastingSummaryResponse object incremental-forecasting

Response envelope for incrementalForecastingSummary. Contains the rows requested (data), pagination info, and metadata describing the query.