Forecasting Service
Get Inventory Forecast
Auction examples
- Running auctions
- Sponsored listings
- Sponsored banners
- Sponsored brands
Asset examples
Webhook examples
Offsite Ads API
- POST[BETA] Create a new advertiser
- GET[BETA] Get advertiser details
- GET[BETA] List all audiences
- POST[BETA] Create a new audience
- POST[BETA] Upload users to an audience
- GET[BETA] List all campaigns
- POST[BETA] Create a new campaign
- GET[BETA] Get campaign details
- PATCH[BETA] Update campaign settings
- GET[BETA] Get campaign geotargeting settings
- GET[BETA] Get Job Status
- GET[BETA] Get campaign performance summary
- GET[BETA] Get daily campaign performance report
- GET[BETA] Get product-level campaign performance report
Assets API
Billing API
- GETGet Billing Contacts
- GETGet Billing Contact
- PUTUpsert Billing Contact
- GETGet Campaign Billing Contact
- PUTUpsert Campaign Billing Contact
- GETGet Marketplace Credit Limitdeprecated
- POSTSet Marketplace Credit Limitdeprecated
- PUTUpsert Vendor Billing Contact
- GETGet Vendor Chargesdeprecated
- GETGet Vendor Account Activitydeprecated
- GETGet Vendor Balance
- POSTAdd Vendor Balance
- POSTBurn Vendor Balance
- GETGet Vendor Credit Historydeprecated
- GETGet Vendor Credit Limitdeprecated
- POSTSet Vendor Credit Limitdeprecated
- DELDelete Vendor Billing Contact
- GETGet Vendor Wallets
- POSTCreate Wallet
- POSTAdjust Wallet Balance
Campaign API
- GETGet Campaigns
- POSTCreate Campaign
- GETGet Campaign By Id
- DELDelete Campaign By Id
- PATCHUpdate Campaign By Id
- GETGet Campaign Bids
- POSTCreate Campaign Bids
- DELDelete Campaign Bid By Id
- PATCHUpdate Campaign Bid By Id
- GETGet Campaign Restriction
- POSTCreate Campaign Restriction
- PATCHUpdate Campaign Restriction
- POST[BETA] Get estimated clicks of a future campaign for a given vendordeprecated
- GETGet Products In Campaign
- GETGet Restriction Types
- GETGet Restriction Type
- GETGet Sponsored Productsdeprecated
Catalog API
Invitation API
Reporting API
- GETGet Campaign Report
- GETGet Campaign Daily Report
- GETGet Campaign Report By Product
- GETGet Product Report
- GETGet Product Daily Report
- GETGet Interactions Dump Urls
- GETGet Scored Attribution Dump Urls
- GETGet Marketplace Interactions Report
- GETGet Marketplace Report
- GETGet Marketplace Campaigns Kpis
- GETGet Marketplace Daily Report
- GETGet Marketplace Vendors Kpis
- GETGet Vendor Report
- GETGet Vendor Daily Report
Segments Service
Toppie API
- GET[BETA] Get Agency Account Balance
- GET[BETA] Get Agency Account Top-ups
- GET[BETA] Get Toppie Campaigns
- POST[BETA] Create Toppie Campaign
- GET[BETA] Get Toppie Campaign Details
- DEL[BETA] Delete Toppie Campaign
- PATCH[BETA] Update Toppie Campaign
- GET[BETA] Get Toppie Campaign Bids
- GET[BETA] List Account Products
- GET[BETA] Get Agency Account Report.
- GET[BETA] Account Activity Reports.
- GET[BETA] Get Campaigns Reporting.
- GET[BETA] Get Campaign Report.
- GET[BETA] Get Campaign Products Report.
Forecasting Service
Get Inventory Forecast
Get inventory forecasts for the given inventory items and time window.
POST
/
public
/
v1
/
toptimize
/
forecasting
/
inventory
curl --request POST \
--url https://api.topsort.com/public/v1/toptimize/forecasting/inventory \
--header 'Content-Type: application/json' \
--data '{
"inventory": [
{
"inventoryType": "category",
"inventoryValue": "<string>"
}
],
"timeWindow": 7
}'
[
{
"dailyForecasts": [
{
"forecastDate": "2023-12-25",
"metrics": [
{
"metricName": "<string>",
"values": {
"forecastIntervalMax": 123,
"forecastIntervalMin": 123,
"forecastValue": 123
}
}
]
}
],
"inventoryType": "category",
"inventoryValue": "<string>"
}
]
Body
application/json
Request model for batch inventory forecasts.
This maps to BatchTriggerForecastRequest in the internal models.
Response
200
application/json
Successful Response
The response is of type object[]
.
curl --request POST \
--url https://api.topsort.com/public/v1/toptimize/forecasting/inventory \
--header 'Content-Type: application/json' \
--data '{
"inventory": [
{
"inventoryType": "category",
"inventoryValue": "<string>"
}
],
"timeWindow": 7
}'
[
{
"dailyForecasts": [
{
"forecastDate": "2023-12-25",
"metrics": [
{
"metricName": "<string>",
"values": {
"forecastIntervalMax": 123,
"forecastIntervalMin": 123,
"forecastValue": 123
}
}
]
}
],
"inventoryType": "category",
"inventoryValue": "<string>"
}
]