get
https://{app-url}{}/api/v2/forecast/tasks//ֿaggregate
Retrieves aggregated forecast results for a specific task
Request Parameters:
The response represents the total forecast across all metrics in the task (i.e., the sum of forecast results for all included metrics). The structure is similar to the GET Forecast Results endpoint, but does not include the last_forecast_ts, last_updated_ts, or metric_id fields.
| Parameter | Type | Description / Example |
|---|---|---|
| forecastTaskId | string ($uuid) | Unique identifier of the forecast task (retrieved from the GET Forecast Tasks endpoint). |
Response Fields:
The response is an array of forecast results. Each result represents a set of predicted data points for a metric. Each data point (per timestamp) includes a predicted value and a confidence band. The confidence band is defined as a range between
lowerBandandupperBand
| Field | Type | Description / Example |
|---|---|---|
| last_forecast_ts | timestamp (epoch) | The last timestamp from which the forecast is generated. For example, for a 7-day daily forecast, if last_forecast_ts is May 5, 2021, the forecast will cover May 6, May 7, and onward. |
| last_updated_ts | timestamp (epoch) | The time when this record was last updated. |
| metric_id | string | Name of the forecasted metric. |
| points | array | Array of forecast data points. |