---
title: "GET /scenario/{scenarioId}"
method: GET
path: "/scenario/{scenarioId}"
tags: ["Scenario"]
---

# GET /scenario/{scenarioId}

`GET /scenario/{scenarioId}`

Retrieves a scenario by its Id

## Path parameters

- `scenarioId` string, uuid, required

## Response `200`

OK

- ScenarioLite
  - `id` string, uuid
  - `name` string, nullable
  - `description` string, nullable
  - `createdOn` string, date-time
  - `lastModified` string, date-time, nullable
  - `scenarioForecasts` ScenarioForecast[], nullable
    - `id` string, uuid
    - `scenarioId` string, uuid
    - `name` string, nullable
    - `description` string, nullable
    - `createdOn` string, date-time
    - `lastModified` string, date-time, nullable
    - `scenarioForecastPoints` ScenarioForecastPoints[], nullable
      - `id` string, uuid
      - `scenarioForecastId` string, uuid
      - `provider` string, uuid
      - `providerId` string, nullable
      - `indicatorName` string, nullable
      - `lastModified` string, date-time
      - `points` Point[], nullable
        - `value` number, double
        - `date` string, date-time
        - `annotation` string, nullable
        - `manuallyAdjusted` boolean
        - `isForecasted` boolean, nullable
      - `offset` integer
      - `includeInAllSegments` boolean
      - `isLogged` boolean
    - `forecastResult` ForecastResult
      - `forecasts` Point[], nullable
        - `value` number, double
        - `date` string, date-time
        - `annotation` string, nullable
        - `manuallyAdjusted` boolean
        - `isForecasted` boolean, nullable
      - `justForecasts` Point[], nullable
        - `value` number, double
        - `date` string, date-time
        - `annotation` string, nullable
        - `manuallyAdjusted` boolean
        - `isForecasted` boolean, nullable
      - `actuals` Point[], nullable
        - `value` number, double
        - `date` string, date-time
        - `annotation` string, nullable
        - `manuallyAdjusted` boolean
        - `isForecasted` boolean, nullable
      - `actualsInModelCalculation` Point[], nullable
        - `value` number, double
        - `date` string, date-time
        - `annotation` string, nullable
        - `manuallyAdjusted` boolean
        - `isForecasted` boolean, nullable
      - `actualsWithForecast` Point[], nullable
        - `value` number, double
        - `date` string, date-time
        - `annotation` string, nullable
        - `manuallyAdjusted` boolean
        - `isForecasted` boolean, nullable
      - `forecastInModelCalculation` Point[], nullable
        - `value` number, double
        - `date` string, date-time
        - `annotation` string, nullable
        - `manuallyAdjusted` boolean
        - `isForecasted` boolean, nullable
    - `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
    - `volumeDecompResult` VolumeDecompResult
      - `decomps` object, nullable
        - `Unknown` ContributionPeriod[]
          - `date` string, date-time
          - `errorFlag` boolean
          - `errorText` string, nullable
          - `yearOverYear` number, double
          - `unexplained` number, double
          - `components` IndicatorContribution[], nullable
            - `entryId` string, nullable
            - `value` number, double
        - `Annual` ContributionPeriod[]
          - `date` string, date-time
          - `errorFlag` boolean
          - `errorText` string, nullable
          - `yearOverYear` number, double
          - `unexplained` number, double
          - `components` IndicatorContribution[], nullable
            - `entryId` string, nullable
            - `value` number, double
        - `SemiAnnual` ContributionPeriod[]
          - `date` string, date-time
          - `errorFlag` boolean
          - `errorText` string, nullable
          - `yearOverYear` number, double
          - `unexplained` number, double
          - `components` IndicatorContribution[], nullable
            - `entryId` string, nullable
            - `value` number, double
        - `Quarterly` ContributionPeriod[]
          - `date` string, date-time
          - `errorFlag` boolean
          - `errorText` string, nullable
          - `yearOverYear` number, double
          - `unexplained` number, double
          - `components` IndicatorContribution[], nullable
            - `entryId` string, nullable
            - `value` number, double
        - `Monthly` ContributionPeriod[]
          - `date` string, date-time
          - `errorFlag` boolean
          - `errorText` string, nullable
          - `yearOverYear` number, double
          - `unexplained` number, double
          - `components` IndicatorContribution[], nullable
            - `entryId` string, nullable
            - `value` number, double
        - `Weekly` ContributionPeriod[]
          - `date` string, date-time
          - `errorFlag` boolean
          - `errorText` string, nullable
          - `yearOverYear` number, double
          - `unexplained` number, double
          - `components` IndicatorContribution[], nullable
            - `entryId` string, nullable
            - `value` number, double
        - `Daily` ContributionPeriod[]
          - `date` string, date-time
          - `errorFlag` boolean
          - `errorText` string, nullable
          - `yearOverYear` number, double
          - `unexplained` number, double
          - `components` IndicatorContribution[], nullable
            - `entryId` string, nullable
            - `value` number, double
        - `Raw` ContributionPeriod[]
          - `date` string, date-time
          - `errorFlag` boolean
          - `errorText` string, nullable
          - `yearOverYear` number, double
          - `unexplained` number, double
          - `components` IndicatorContribution[], nullable
            - `entryId` string, nullable
            - `value` number, double
      - `entries` 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
    - `scenarioCoefficients` ScenarioCoefficient[], nullable
      - `id` string, uuid
      - `scenarioForecastId` string, uuid
      - `provider` string, uuid
      - `providerId` string, nullable
      - `coefficients` DoubleEditable[], nullable
        - `originalValue` number, double
        - `currentValue` number, double
    - `forecastModel` ForecastModelInfo — This schema contains information about the Model, the dependent variable or Primary Indicator of the model under the Indicator subschema, and dependent variables or Explanatory Indicators in the ForecastModelEntry subschema. If the Model is locked information is populated in the LockedModelInfo subschema.
      - `id` string, uuid — The id of the model.
      - `name` string, nullable — The name of the model.
      - `description` string, nullable — The description of the model.
      - `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
      - `created` string, date-time — The timestamp in UTC for when the model was created.
      - `lastModified` string, date-time — The timestamp in UTC when the model was last saved.
      - `owner` string, nullable — The username of the owner of the model.
      - `companyName` string, nullable — The name of the company the model belongs to.
      - `companyPrefix` string, nullable — The prefix of the company. A shortened name in the application which is used to differentiate between companies.
      - `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
      - `type` 0 | 1 | 2 | 3 | 4 — None: 0 Rocet: 1 Multivariate: 2 SegmentedMultivariate: 3 WeightedUnivariateRegression: 4
      - `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
      - `cutOffPeriods` integer — The target horizon of the model. Any forecasts after the cut off periods will be trimmed.
      - `active` boolean — A flag to signal that the model is locked. True: Model is locked and it should have a LockedModel associated with it. False: Model is not locked and is editable in the application.
      - `projectId` string, uuid — The UUID for the project the model is in.
      - `usedAsIndicator` boolean — A flag to signal that an indicator has been created from the model.
      - `analysisAsOfDate` string, date-time — The As Of Date of the model. This is used to front trim the model's dependent variable to use less than the full data history to run a back test or by locked models to set their coefficients to a certain model period.
      - `logPrimary` boolean — A flag which is used to determine if the primary dataset should be log(x + 1) transformed. If this is true the calculation must be 'None' True: Transform the points. False: Does not transform the points.
      - `activeLockedModel` string, uuid, nullable — The locked model Id.
      - `tags` string[], nullable — A list of tags that are assigned to the model.
      - `entries` ForecastModelEntry[], nullable — A list of the entries that are in the model. Includes hidden indicators as well.
        - `indicator` 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.
        - `displayName` string, nullable — A user defined name for an indicator.
        - `displayDescription` string, nullable — A user defined description for an indicator.
        - `displayColor` string, nullable — A user defined color for an indicator. A valid six integer hex value with the leading #
        - `displayCategory` string, nullable — A user defined category for the indicator.
        - `offset` integer — The number of periods to shift the data when modeling.
        - `includeInModel` boolean — A flag used to determine if the indicator should be used when modeling.
        - `includeInAllSegments` boolean — A flag used to force the indicator in every segment. If true the indicator will be used in all segments, but may trim the model forecast to periods where data exists for the forced indicator. Only allowed for entries with an offset of 0.
        - `isLogged` boolean — A flag used to determine if the data for this indicator should be logged transformed.
        - `transformations` Transformation[], nullable — The series transformations applied to the series of this entry and the order that they are applied
          - `order` integer
          - `required` boolean
      - `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.
      - `url` string, nullable — The link to the model in the application.
      - `parentType` string, nullable — The parent type of the model. Currently only parent type is a 'predict'
      - `parentId` string, uuid — The UUID of the parent entity of the model.
      - `parentUrl` string, nullable — The URL to the model's parent entity.
      - `notes` string, nullable — User entered notes for the model.
      - `modelState` string, nullable — The state of the model. Currently there are three possible options: Draft Archive Production
      - `manual` boolean — If true, model output was manually entered.
      - `modelForecastSummary` string, nullable — For models in the Insights dashboard, an AI generated summary of the forecast.
    - `trimmedData` object, nullable
  - `points` Point[], nullable
    - `value` number, double
    - `date` string, date-time
    - `annotation` string, nullable
    - `manuallyAdjusted` boolean
    - `isForecasted` boolean, nullable

## Other responses

- `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)