NOTE: This is an article for the legacy API. To access updated information on this endpoint, please reference the HTML guide attached to the bottom of the REST API Access document
Description: Gets results from the grid in the Overforecasted screen
Resource: OverforecastedPeriodDetail/
Verb: GET
Query String Options:
- nodeLevel (required): Hierarchy Node Level. Top company level = 0. This corresponds to the levels you have configured in Forecast Manager's tree view
- itemHierarchyId (required): which hierarchy is being used, usually "1"
- demandForecastSeriesId (required): which forecast series to view, usually "1"
Returns: JSON Array of objects
Example Response JSON:
[{
"AlertKeyId": 1202305014087,
"AlertType": 9,
"PrimaryId": 4087,
"PrimaryIdProperty": 3,
"ForecastErrorPercent": 0.3799456862745098039215686275,
"StatisticalErrorPercent": 0.1753009803921568627450980392,
"LevelName": "Customer Group",
"OverforecastRevenueVariance": 273.02517,
"NodeLevel": 5,
"HierarchyProperty": 2048,
"ShipperId": 4,
"SiteId": 5,
"ItemId": 73,
"BuyerId": 6,
"PrimarySupplierId": 28,
"CustomerShipToCategory1Id": 2,
"CustomerId": 0,
"CustomerShipToId": 0,
"ItemSiteCategory1Id": 9,
"ItemSiteCategory2Id": 7,
"ItemSiteCategory3Id": 1,
"ItemSiteCategory4Id": 1,
"ItemSiteCategory5Id": 1,
"ItemSiteId": 142,
"DemandForecastSeriesName": "Operational Forecast",
"NodeValue": "Sam's Club",
"HierarchyNodeId": 4087,
"DemandForecastSeriesId": 1,
"PeriodDate": "2023/05/01",
"Interval": 4,
"ForecastQuantity": 70.37723,
"StatisticalForecastQuantity": 59.94035,
"ForecastAverageQuantity": 74.30597,
"StatisticalAverageQuantity": 63.98437,
"ForecastRevenue": 991.61517,
"StatisticalForecastRevenue": 844.55953,
"AverageForecastErrorPercent": 0.21549,
"AverageStatisticalErrorPercent": 0.06429,
"AverageForecastErrorUnits": 15.04862,
"AverageStatisticalErrorUnits": 4.48960,
"PeriodTotalQuantitySold": 51.00000,
"PeriodTotalRevenue": 718.59000,
"PercentThroughPeriod": 1.00000,
"PercentOfDemandExpected": 1.00000,
"ProjectedPeriodTotalQuantitySold": 51.00000,
"ProjectedPeriodTotalRevenue": 718.59000,
"ForecastErrorUnits": 19.37723,
"ForecastErrorDollars": 273.02517,
"StatisticalErrorUnits": 8.94035,
"StatisticalErrorDollars": 125.96953,
"UsagePattern": 2,
"IsAutoForecasted": true,
"ProjectedInventoryPosition": 24,
"ShipperName": "Shipper BBC",
"ItemCode": "0201006",
"ItemDescription": "Adventure Works 13\" Color TV E25 White",
"SiteCode": "9",
"CustomerShipToCategory1Value": "Sam's Club",
"ItemSiteCategory1Name": "TV and Video",
"ItemSiteCategory2Name": "Televisions",
"ItemSiteCategory3Name": "Unassigned",
"ItemSiteCategory4Name": "Unassigned",
"ItemSiteCategory5Name": "Unassigned",
"AbcClass": "A",
"XyzClass": "X",
"BuyerName": "AJ Foyt",
"PrimarySupplierName": "Weyland Yutani",
"ActiveOrderPolicy": 2,
"AlertSummaryId": 3334,
"AMsg": "Demand in period 5/1/2023 of 51 is below min expected range.",
"DateCreated": "2023/06/01",
"DateUpdated": "2023-06-01T00:00:00-05:00",
"ASt": 1,
"APri": 2,
"Rank": 63,
"AlertTypeName": "OverForecast"
},
...
]