> ## Documentation Index
> Fetch the complete documentation index at: https://developers.criteo.com/llms.txt
> Use this file to discover all available pages before exploring further.
# /experimental/retail-media/accounts/{account-id}/compute-onsite-display-forecast
> Computes a forecast of available impressions and budget for a retailer account.
This endpoint is subject to specific rate limits.
## OpenAPI
````yaml https://api.criteo.com/experimental/retailmedia/open-api-specifications.json post /experimental/retail-media/accounts/{account-id}/compute-onsite-display-forecast
openapi: 3.0.1
info:
title: Criteo API
description: Criteo API - RetailMedia
version: Experimental
servers:
- url: https://api.criteo.com
security:
- oauth: []
tags:
- name: Accounts
- name: Analytics
- name: Audience
- name: Balance
- name: Campaign
- name: Catalog
- name: Forecasting
- name: Gateway
- name: ThirdPartyAccounts
paths:
/experimental/retail-media/accounts/{account-id}/compute-onsite-display-forecast:
post:
tags:
- Forecasting
summary: >-
/experimental/retail-media/accounts/{account-id}/compute-onsite-display-forecast
description: >-
Computes a forecast of available impressions and budget for a retailer
account.
This endpoint is subject to specific rate limits.
operationId: ComputeOnsiteDisplayForecast
parameters:
- name: account-id
in: path
description: >-
ID of the retailer account for which to compute the onsite display
forecast.
required: true
schema:
type: string
requestBody:
description: Forecast computation parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeOnsiteDisplayForecastRequest'
required: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/OnsiteDisplayForecastListResponse'
security:
- oauth:
- RetailMedia_Forecasting_Read
components:
schemas:
ComputeOnsiteDisplayForecastRequest:
required:
- data
type: object
properties:
data:
allOf:
- $ref: '#/components/schemas/ComputeOnsiteDisplayForecastResource'
description: A value resource exposed by the API.
additionalProperties: false
description: >-
A top-level object that encapsulates a Criteo API request for a single
value object.
OnsiteDisplayForecastListResponse:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/OnsiteDisplayForecastResource'
nullable: true
errors:
type: array
items:
$ref: '#/components/schemas/SdkApiRestCommonProblem'
description: Errors that occured during this call.
nullable: true
readOnly: true
warnings:
type: array
items:
$ref: '#/components/schemas/SdkApiRestCommonProblem'
description: Warnings that occured during this call.
nullable: true
readOnly: true
additionalProperties: false
description: >-
A top-level object that encapsulates a Criteo API response for several
value objects.
ComputeOnsiteDisplayForecastResource:
required:
- attributes
- type
type: object
properties:
attributes:
allOf:
- $ref: '#/components/schemas/ComputeOnsiteDisplayForecast'
description: Attributes of the resource.
type:
type: string
description: Type of the resource.
additionalProperties: false
description: A value resource exposed by the API.
OnsiteDisplayForecastResource:
required:
- attributes
- type
type: object
properties:
attributes:
allOf:
- $ref: '#/components/schemas/OnsiteDisplayForecast'
description: Attributes of the resource.
type:
type: string
description: Type of the resource.
additionalProperties: false
description: A value resource exposed by the API.
SdkApiRestCommonProblem:
type: object
properties:
code:
type: string
description: A machine-readable error code, expressed as a string value.
nullable: true
detail:
type: string
description: >-
A human-readable explanation specific to this occurrence of the
problem.
nullable: true
instance:
type: string
description: A URI that identifies the specific occurrence of the problem.
nullable: true
source:
type: object
additionalProperties:
type: string
description: >-
A machine-readable structure to reference to the exact location(s)
causing the error(s).
nullable: true
stackTrace:
type: string
description: ''
nullable: true
title:
type: string
description: A short human-readable description of the problem type.
nullable: true
traceId:
type: string
description: The request correlation ID this problem comes from.
nullable: true
type:
enum:
- unknown
- access-control
- authentication
- authorization
- availability
- deprecation
- quota
- validation
type: string
description: The problem's category.
nullable: true
additionalProperties: false
description: Common problem object.
ComputeOnsiteDisplayForecast:
required:
- endDate
- pageSettings
- retailerId
- startDate
type: object
properties:
buyType:
enum:
- auction
- preferredDeals
- sponsorship
type: string
description: How the inventory is bought.
default: auction
creativeFormats:
type: array
items:
enum:
- flagShip
- showcase
- butterfly
- bundleBoost
- iab
- custom
- displayPanel
- digitalShelfTalker
- commerceVideoSpotlight
- brandingVideoStandout
type: string
description: Creative formats accepted in a request.
description: >-
Restricts the forecast to these creative formats. Defaults to all
formats.
endDate:
type: string
description: "Last day of the forecast period, inclusive, as `YYYY-MM-DD`. May equal\r\n`startDate` for a single-day forecast."
format: date
frequencyCapping:
allOf:
- $ref: '#/components/schemas/FrequencyCapping'
description: Frequency capping to apply. Omit to forecast without a cap.
pageSettings:
type: array
items:
$ref: '#/components/schemas/PageSetting'
description: >-
Page types to include, at least one, and at most one entry per page
type.
retailerId:
type: string
description: Identifies the retailer whose inventory is being forecast.
startDate:
type: string
description: First day of the forecast period, as `YYYY-MM-DD`.
format: date
additionalProperties: false
description: Parameters for computing an Onsite Display forecast.
OnsiteDisplayForecast:
required:
- availableImpressions
- budget
- details
- pageType
- reservationRate
type: object
properties:
availableImpressions:
type: integer
description: Estimated available impressions over the whole forecast period.
format: int64
averageCpm:
allOf:
- $ref: '#/components/schemas/Money'
description: >-
Average CPM across the period. Omitted when no inventory data is
available.
budget:
allOf:
- $ref: '#/components/schemas/Money'
description: Estimated budget over the whole forecast period.
details:
type: array
items:
$ref: '#/components/schemas/InventoryForecastDetail'
description: "Daily breakdown, one entry per row of the grain described on\r\n`InventoryForecastDetail`."
pageType:
enum:
- search
- home
- browse
- checkout
- category
- productDetail
- confirmation
- merchandising
- deals
- favorites
- searchBar
- categoryMenu
- unknown
type: string
description: Page type this forecast applies to.
reservationRate:
type: number
description: Proportion of inventory already reserved, from 0.0 to 1.0.
format: double
additionalProperties: false
description: >-
The forecast for one page type, returned as an item of the response
`data` array.
FrequencyCapping:
required:
- count
- durationType
type: object
properties:
count:
type: integer
description: "Maximum impressions per user per window. Must be at least 1 - omit the whole frequency\r\ncapping object to forecast without a cap."
format: int32
durationType:
enum:
- session
- day
type: string
description: The window the cap applies over.
additionalProperties: false
description: >-
Caps how often the same user may be shown an impression while the
forecast is computed.
PageSetting:
required:
- pageType
type: object
properties:
keywords:
type: array
items:
type: string
description: "Keywords to filter inventory by, up to 100. Required when `pageType` is\r\n`search` or `searchBar`. Recommended\r\nkeywords come from `POST /retail-media/retailers/{retailerId}/recommend-keywords`."
pageCpm:
allOf:
- $ref: '#/components/schemas/Money'
description: >-
Bid CPM override for this page type, as a price per 1,000
impressions.
pageType:
enum:
- search
- home
- browse
- checkout
- category
- productDetail
- confirmation
- merchandising
- deals
- favorites
- searchBar
- categoryMenu
type: string
description: Page type to forecast.
taxonomyIds:
type: array
items:
type: string
description: "Retail Media category IDs to filter inventory by, up to 100. Required when\r\n`pageType` is `category`,\r\n`productDetail`, `categoryMenu` or\r\n`merchandising`. The ids come from the returned category `id`\r\nof `POST /retail-media/retailers/{retailerId}/categories/search`."
additionalProperties: false
description: >-
One page type to include in the forecast, and how to filter its
inventory.
Money:
required:
- currency
- value
type: object
properties:
currency:
type: string
description: The ISO 4217 currency code, for example `USD`.
value:
type: number
description: "The monetary value. Decimal so that amounts round-trip without the rounding errors a binary\r\nfloating point type would introduce."
format: double
additionalProperties: false
description: A monetary amount, in the account's currency.
InventoryForecastDetail:
required:
- availableImpressions
- averageCpm
- budget
- creativeFormats
- date
- placementConfigId
type: object
properties:
availableImpressions:
type: integer
description: Estimated available impressions for this day.
format: int64
averageCpm:
allOf:
- $ref: '#/components/schemas/Money'
description: Average CPM for this day.
budget:
allOf:
- $ref: '#/components/schemas/Money'
description: Estimated available budget for this day.
creativeFormats:
type: array
items:
enum:
- flagShip
- showcase
- butterfly
- bundleBoost
- iab
- custom
- displayPanel
- digitalShelfTalker
- commerceVideoSpotlight
- brandingVideoStandout
- unknown
type: string
description: Creative formats returned in a response.
description: "Every creative format available on this placement configuration, restricted to the formats\r\nthe request asked for. The row aggregates them - impressions are not split per format."
date:
type: string
description: The forecast day, as `YYYY-MM-DD`.
format: date
keyword:
type: string
description: >-
The keyword this row is for. Present only for search and search bar
pages.
placementConfigId:
type: string
description: Placement configuration this row is for.
taxonomyId:
type: string
description: "The taxonomy id this row is for. Present only for category, product detail, category menu\r\nand merchandising pages."
additionalProperties: false
description: One row of a page type's daily breakdown.
securitySchemes:
oauth:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://api.criteo.com/oauth2/token
scopes:
RetailMedia_Accounts_Read: >-
Grants Read access to the capabilities from the Accounts domain,
for RetailMedia applications
RetailMedia_Analytics_Read: >-
Grants Read access to the capabilities from the Analytics domain,
for RetailMedia applications
RetailMedia_Audience_Manage: >-
Grants Manage access to the capabilities from the Audience domain,
for RetailMedia applications
RetailMedia_Balance_Read: >-
Grants Read access to the capabilities from the Balance domain,
for RetailMedia applications
RetailMedia_Campaign_Manage: >-
Grants Manage access to the capabilities from the Campaign domain,
for RetailMedia applications
RetailMedia_Campaign_Read: >-
Grants Read access to the capabilities from the Campaign domain,
for RetailMedia applications
RetailMedia_Catalog_Manage: >-
Grants Manage access to the capabilities from the Catalog domain,
for RetailMedia applications
RetailMedia_Catalog_Read: >-
Grants Read access to the capabilities from the Catalog domain,
for RetailMedia applications
RetailMedia_Forecasting_Read: >-
Grants Read access to the capabilities from the Forecasting
domain, for RetailMedia applications
RetailMedia_ThirdPartyAccounts_Manage: >-
Grants Manage access to the capabilities from the
ThirdPartyAccounts domain, for RetailMedia applications
authorizationCode:
authorizationUrl: https://api.criteo.com/oauth2
tokenUrl: https://api.criteo.com/oauth2/token
scopes:
RetailMedia_Accounts_Read: >-
Grants Read access to the capabilities from the Accounts domain,
for RetailMedia applications
RetailMedia_Analytics_Read: >-
Grants Read access to the capabilities from the Analytics domain,
for RetailMedia applications
RetailMedia_Audience_Manage: >-
Grants Manage access to the capabilities from the Audience domain,
for RetailMedia applications
RetailMedia_Balance_Read: >-
Grants Read access to the capabilities from the Balance domain,
for RetailMedia applications
RetailMedia_Campaign_Manage: >-
Grants Manage access to the capabilities from the Campaign domain,
for RetailMedia applications
RetailMedia_Campaign_Read: >-
Grants Read access to the capabilities from the Campaign domain,
for RetailMedia applications
RetailMedia_Catalog_Manage: >-
Grants Manage access to the capabilities from the Catalog domain,
for RetailMedia applications
RetailMedia_Catalog_Read: >-
Grants Read access to the capabilities from the Catalog domain,
for RetailMedia applications
RetailMedia_Forecasting_Read: >-
Grants Read access to the capabilities from the Forecasting
domain, for RetailMedia applications
RetailMedia_ThirdPartyAccounts_Manage: >-
Grants Manage access to the capabilities from the
ThirdPartyAccounts domain, for RetailMedia applications
````