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: Returns the Forecast Error Summary grid in Forecast Error screen
Resource: ForecastErrorSummary/fetchby/
Verb: POST
Query String Options:
- itemHierarchyId (required): which hierarchy is being used, usually "1"
- demandForecastSeriesId (required): which forecast series to view, usually "1"
- nodeLevel (required): Hierarchy Node Level. Top company level = 0. This corresponds to the levels you have configured in Forecast Manager's tree view
- hierarchyNodeFilters (required): filters from the Filters Pane
Returns: JSON Array of ForecastErrorSummary objects
Example URL: https://demo3.stockiqtech.net/api/ForecastErrorsSummary/fetchby/hierarchyNodeFilters/?itemHierarchyId=1&demandForecastSeriesId=1&nodeLevel=5
Example Response JSON:
[{
"AlertKeyId": 13957,
"AlertType": 10,
"PrimaryId": 3957,
"PrimaryIdProperty": 3,
"LeadTimeAgoLagPeriodCount": 1,
"SnapshotDate": "2024/05/11",
"LeadTimeAgoAverageForecastErrorPercent": 0.27713,
"LeadTimeAgoMeanAbsoluteError": 17.68656,
"LeadTimeAgoAverageForecastErrorValue": 427.42172,
"LeadTimeAgoForecastBiasPercent": -0.15601096866096853,
"LeadTimeAgoNaiveForecastErrorPercent": 0.18868,
"LeadTimeAgoNaiveForecastMeanAbsoluteError": 11.85599,
"LeadTimeAgoNaiveForecastErrorValue": 286.51743,
"LeadTimeAgoNaiveForecastBiasPercent": 0.10353750971689935,
"LeadTimeAgoStatForecastErrorPercent": 0.08956,
"LeadTimeAgoStatForecastMeanAbsoluteError": 5.62769,
"LeadTimeAgoStatForecastErrorValue": 136.00143,
"LeadTimeAgoStatForecastBiasPercent": 0.047196950715655106,
"StatisticalVsNaiveForecastValueAdded": 0.08579,
"OperationalVsStatisticalForecastValueAdded": -0.18810,
"LeadTimeAgoAverageForecastErrorPercentVsCurrent": 0.26400,
"LeadTimeAgoMeanAbsoluteErrorVsCurrent": 16.67630,
"LeadTimeAgoAverageForecastErrorValueVsCurrent": 403.00746,
"LeadTimeAgoForecastBiasPercentVsCurrent": -0.13714540897097593,
"LeadTimeAgoNaiveForecastErrorPercentVsCurrent": 0.16151,
"LeadTimeAgoNaiveForecastMeanAbsoluteErrorVsCurrent": 10.20213,
"LeadTimeAgoNaiveForecastErrorValueVsCurrent": 246.54962,
"LeadTimeAgoNaiveForecastBiasPercentVsCurrent": 0.076808753434849608,
"LeadTimeAgoStatForecastErrorPercentVsCurrent": 0.06847,
"LeadTimeAgoStatForecastMeanAbsoluteErrorVsCurrent": 4.32549,
"LeadTimeAgoStatForecastErrorValueVsCurrent": 104.53201,
"LeadTimeAgoStatForecastBiasPercentVsCurrent": 0.026332688850752017,
"LeadTimeAgoStatisticalVsNaiveForecastValueAdded": 0.09304,
"LeadTimeAgoOperationalVsStatisticalForecastValueAdded": -0.19553,
"LagPeriodAverageForecastErrorPercent": 0.09934,
"LagPeriodMeanAbsoluteError": 5.56348,
"LagPeriodAverageForecastErrorValue": 134.44967,
"LagPeriodForecastBiasPercent": 0.09934785714285721,
"LagPeriodNaiveForecastErrorPercent": 0.12572,
"LagPeriodNaiveForecastMeanAbsoluteError": 7.04050,
"LagPeriodNaiveForecastErrorValue": 170.14415,
"LagPeriodNaiveForecastBiasPercent": 0.12572330815042454,
"LagPeriodStatForecastErrorPercent": 0.04709,
"LagPeriodStatForecastMeanAbsoluteError": 2.63757,
"LagPeriodStatForecastErrorValue": 63.74084,
"LagPeriodStatForecastBiasPercent": 0.047099532017650825,
"LagPeriodStatisticalVsNaiveForecastValueAdded": 0.07863,
"LagPeriodOperationalVsStatisticalForecastValueAdded": -0.05225,
"ItemTagAssignments": [],
"HierarchyNodeId": 3957,
"ShipperId": 3,
"SiteId": 15,
"ItemId": 18,
"BuyerId": 9,
"PrimarySupplierId": 28,
"CustomerShipToCategory1Id": 2,
"CustomerId": 0,
"CustomerShipToId": 0,
"ItemSiteCategory1Id": 2,
"ItemSiteCategory2Id": 8,
"ItemSiteCategory3Id": 1,
"ItemSiteCategory4Id": 1,
"ItemSiteCategory5Id": 1,
"ItemSiteCategory6Id": 1,
"ItemSiteCategory7Id": 1,
"ItemSiteCategory8Id": 1,
"NodeTitle": "0101003 @ Contoso Nagoya Store -> Sam's Club",
"DemandForecastSeriesId": 1,
"DemandForecastSeriesName": "Operational Forecast",
"NodeValue": "Sam's Club",
"ShipperName": "Shipper BBC",
"ItemCode": "0101003",
"SiteCode": "271",
"BuyerName": "Alberto Ascari",
"PrimarySupplierName": "Tyrell Corp. ",
"CustomerShipToCategory1Value": "Sam's Club",
"AbcClass": "A",
"XyzClass": "X",
"ActiveOrderPolicy": 2,
"ResolvedItemStatus": 1,
"ItemDescription": "Contoso 1G MP3 Player E100 White",
"ItemSiteCategory1Name": "Audio",
"ItemSiteCategory2Name": "MP4&MP3",
"ItemSiteCategory3Name": "Unassigned",
"ItemSiteCategory4Name": "Unassigned",
"ItemSiteCategory5Name": "Unassigned",
"ItemSiteCategory6Name": "Unassigned",
"ItemSiteCategory7Name": "Unassigned",
"ItemSiteCategory8Name": "Unassigned",
"UsagePattern": 0,
"NaiveForecastErrorPercent": 0.16169,
"NaiveForecastMeanAbsoluteError": 10.21362,
"NaiveForecastErrorValue": 246.82736,
"NaiveForecastBiasPercent": 0.076863391558551486,
"StatForecastErrorPercent": 0.07590,
"StatForecastMeanAbsoluteError": 4.79436,
"StatForecastErrorValue": 115.86278,
"StatForecastBiasPercent": 0.048373502732139473,
"LeadTimeAgoDemandForecastSnapshotId": 2414,
"Interval": 4,
"DemandForecastErrorPercent": 0.26400,
"DemandForecastMeanAbsoluteError": 16.67631,
"DemandForecastErrorValue": 403.00754,
"DemandForecastBiasPercent": -0.13714540897097593,
"AlertSummaryId": 5206,
"AMsg": "Forecast error of 26.40% results in error of 16.68, worth $403.01, which is outside allowed range. Check for unusual demand or poor forecasts.",
"DateCreated": "2024/06/17",
"DateUpdated": "2024-06-17T00:00:00-05:00",
"ASt": 1,
"APri": 1,
"Rank": 1221,
"AlertTypeName": "ForecastError"
},
...
]