---
title: "GET /rawmodel/{ForecastModelId}/{UseForecastFrequency}"
method: GET
path: "/rawmodel/{ForecastModelId}/{UseForecastFrequency}"
tags: ["ForecastModel"]
---

# GET /rawmodel/{ForecastModelId}/{UseForecastFrequency}

`GET /rawmodel/{ForecastModelId}/{UseForecastFrequency}`

Retrieves the component data of a forecast model

## Path parameters

- `ForecastModelId` string, uuid, required
- `UseForecastFrequency` boolean, required

## Query parameters

- `ExcludeIndicators` boolean
- `AsOfDate` string

## Response `200`

OK

- ForecastModelComponentInfo
  - `indicators` IndicatorEntry[], 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
    - `offset` integer
    - `values` Point[], nullable
      - `value` number, double
      - `date` string, date-time
      - `annotation` string, nullable
      - `manuallyAdjusted` boolean
      - `isForecasted` boolean, nullable
    - `includeInModel` boolean
    - `isLogged` boolean
    - `entryId` string, uuid
    - `useCoefficientBounds` boolean
    - `coefficientLowerBounds` number, double, nullable
    - `coefficientUpperBounds` number, double, nullable
    - `transformations` Transformation[], nullable
      - `order` integer
      - `required` boolean
  - `coefficients` array[], nullable
    - Coefficient[]
      - `value` number, double
      - `standardError` number, double
      - `tValue` number, double
      - `confidence95` string, nullable
      - `type` string, nullable
      - `indicatorName` string, nullable
      - `dates` string[], nullable
      - `pValue` number, double
      - `vif` number, double
      - `cooksDistanceCoefficient` number, double
      - `quadraticPValue` number, double
  - `messages` BuilderMessage[], nullable
    - `message` string, nullable
    - `title` string, nullable
    - `type` 0 | 1 | 2 | 3
  - `startDate` string, date-time
  - `categories` ForecastModelCategoryInfo[], nullable
    - `id` string, uuid
    - `name` string, nullable
    - `sort` integer
    - `note` string, nullable
    - `indicators` IndicatorKey[], nullable
      - `provider` string, uuid — The ID of the provider for the indicator.
      - `providerId` string, nullable — The provider id of the indicator.
  - `lockedModel` LockedModelInfo
    - `name` string, nullable — The name of the locked model.
    - `createdOn` string, date-time — When the locked model was created.
    - `asOf` string, date-time, nullable — An optional date used to trim the model period.
    - `lockedBy` string, nullable — The user who locked the model.
    - `lastCheckedBy` string, nullable — The last user to trigger a model health check.
    - `modelScoreWhenLocked` number, double — The model quality score when the model was locked.
    - `dataEndDateWhenLocked` string, date-time, nullable — The last date in the model period when the model was locked.
    - `lastModelCheckupDate` string, date-time, nullable — The last time model health was checked.
  - `biasInfo` SegmentBiasInfo[], nullable
    - `logTransformationBias` number, double, nullable
    - `dates` string[], 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)