---
title: "GET /forecastmodelhistory/{ForecastModelId}"
method: GET
path: "/forecastmodelhistory/{ForecastModelId}"
tags: ["ForecastModelHistory"]
---

# GET /forecastmodelhistory/{ForecastModelId}

`GET /forecastmodelhistory/{ForecastModelId}`

Retrieves the forecast model's history

## Path parameters

- `ForecastModelId` string, uuid, required

## Response `200`

OK

- ForecastModelHistory
  - `captureDate` string, date-time
  - `forecastModelIteration` ForecastModelIteration
    - `forecastModelName` string, nullable
    - `forecastModelId` string, uuid
    - `forecastModelType` 0 | 1 | 2 | 3 | 4 — None: 0 Rocet: 1 Multivariate: 2 SegmentedMultivariate: 3 WeightedUnivariateRegression: 4
    - `forecastModelCalculation` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 — The transformation applied to the data. Possible options: None 1 PeriodOverPeriod 2 YearOverYear 3 ThreePeriodYearOverYear 6
    - `executionTime` string, date-time
    - `fitAndForecast` Point[], nullable — Forecast Model output values with no calculation applied and trimmed using regression start and as of dates
      - `value` number, double
      - `date` string, date-time
      - `annotation` string, nullable
      - `manuallyAdjusted` boolean
      - `isForecasted` boolean, nullable
    - `primaryValues` Point[], nullable — Time series data of Primary Indicator with no calculation applied
      - `value` number, double
      - `date` string, date-time
      - `annotation` string, nullable
      - `manuallyAdjusted` boolean
      - `isForecasted` boolean, nullable
    - `components` ComponentInformation[], nullable — Model components, excluding user specified indicators, ordered by offset
      - `deprecated` boolean
      - `name` string, nullable
      - `provider` string, uuid
      - `providerId` string, nullable
      - `offset` integer
      - `values` Point[], nullable
        - `value` number, double
        - `date` string, date-time
        - `annotation` string, nullable
        - `manuallyAdjusted` boolean
        - `isForecasted` boolean, nullable
    - `segments` SegmentInfo[], nullable
      - `segment` integer
      - `intercept` number, double
      - `coefficients` CoefficientInfo[], nullable — Component coefficients ordered by indicator offset
        - `indicatorKey` IndicatorKey — The provider:providerId pair. This is used to identify an indicator in the system.
          - `provider` string, uuid — The ID of the provider for the indicator.
          - `providerId` string, nullable — The provider id of the indicator.
        - `value` number, double
    - `contributionResult` ContributionResult
      - `forecast` Point[], nullable
        - `value` number, double
        - `date` string, date-time
        - `annotation` string, nullable
        - `manuallyAdjusted` boolean
        - `isForecasted` boolean, nullable
      - `componentContributions` IndicatorValues[], nullable
        - `indicator` Indicator
          - `id` string, uuid
          - `name` string, nullable
          - `description` string, nullable
          - `aggregate` 0 | 1 | 2 | 3 | 4 | 5 | 6
          - `calculation` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 — The transformation applied to the data. Possible options: None 1 PeriodOverPeriod 2 YearOverYear 3 ThreePeriodYearOverYear 6
          - `color` string, nullable
          - `displayInformation` DisplayInformation
            - `name` string, nullable — The display name to be used in the application. Limited to 50 characters.
            - `description` string, nullable — The description to be shown in the application. Limited to 1,000 characters.
            - `color` string, nullable — The color to use in the application. Must be a valid hex color code.
            - `category` string, nullable — The category of the indicator. Limited to 1,000 characters.
          - `count` integer
          - `created` string, date-time
          - `startTime` string, date-time, nullable
          - `endTime` string, date-time, nullable
          - `transformedStartTime` string, date-time, nullable
          - `transformedEndTime` string, date-time, nullable
          - `frequency` 0 | 1 | 2 | 4 | 12 | 52 | 365 | 1000 — The frequency of the data. Daily: 365 Weekly: 52 Monthly: 12 Quarterly: 4 SemiAnnual: 2 Annual: 1
          - `deprecated` boolean
          - `deprecationReason` string, nullable
          - `lastModified` string, date-time
          - `provider` Provider
            - `name` string, nullable
            - `description` string, nullable
            - `id` string, uuid
            - `source` string, nullable
          - `providerId` string, nullable
          - `seasonality` 0 | 1 | 999
          - `source` string, nullable
          - `classification` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10
          - `tags` string[], nullable
          - `type` string, nullable
          - `units` string, nullable
          - `accessibility` 0 | 1 | 2
          - `periodAlignment` 0 | 1 | 2
          - `path` string, nullable
          - `notes` string, nullable
          - `citation` string, nullable
          - `dataSources` IndicatorDataSource[], nullable
            - `name` string, nullable
            - `url` string, nullable
            - `dataSourceType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7
          - `industryCodes` IndustryCode[], nullable
            - `type` string, nullable
            - `code` string, nullable
          - `hasZeroVariance` boolean, nullable
          - `interval` string, nullable
          - `countryCode` string, nullable
        - `leadTime` integer
        - `values` Point[], nullable
          - `value` number, double
          - `date` string, date-time
          - `annotation` string, nullable
          - `manuallyAdjusted` boolean
          - `isForecasted` boolean, nullable

## Other responses

- `422` — Model is expired or in a non-production state
- `429` — If the user has sent too many requests

---

[API](https://skmtc.net/prevedere/apis/board-foresight-api-v1.md) · [All operations](https://skmtc.net/prevedere/apis/board-foresight-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/prevedere/board-foresight-api-v1/revisions/c5ac8232e334/schema)