Prevedere Scenario API

openapi: 3.2.0
info:
  title: Board Foresight API - V1 Alert Scenario API
  description: ''
  version: v1
servers:
- url: https://api.prevedere.com
  description: Base URL declared by the provider in apis.yml (roadmap#122).
security:
- api key: []
tags:
- name: Scenario
  description: ''
paths:
  /scenarios:
    get:
      tags:
      - Scenario
      description: Retrieves a list of scenarios names and Ids for a user's company
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ScenarioListing'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ScenarioListing'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ScenarioListing'
        '429':
          description: If the user has sent too many requests
  /scenario/{scenarioId}:
    get:
      tags:
      - Scenario
      description: Retrieves a scenario by its Id
      parameters:
      - name: scenarioId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ScenarioLite'
            application/json:
              schema:
                $ref: '#/components/schemas/ScenarioLite'
            text/json:
              schema:
                $ref: '#/components/schemas/ScenarioLite'
        '429':
          description: If the user has sent too many requests
components:
  schemas:
    IndicatorType:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      type: integer
      format: int32
    IndicatorContribution:
      type: object
      properties:
        entryId:
          type:
          - string
          - 'null'
        value:
          type: number
          format: double
      additionalProperties: false
    Provider:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        id:
          type: string
          format: uuid
        source:
          type:
          - string
          - 'null'
      additionalProperties: false
    ScenarioListing:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        createdOn:
          type: string
          format: date-time
        lastModified:
          type:
          - string
          - 'null'
          format: date-time
        scenarioForecasts:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ScenarioForecastListing'
      additionalProperties: false
    ForecastResult:
      type: object
      properties:
        forecasts:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Point'
        justForecasts:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Point'
        actuals:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Point'
        actualsInModelCalculation:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Point'
        actualsWithForecast:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Point'
        forecastInModelCalculation:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Point'
      additionalProperties: false
    DisplayInformation:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: The display name to be used in the application. Limited to 50 characters.
        description:
          type:
          - string
          - 'null'
          description: The description to be shown in the application. Limited to 1,000 characters.
        color:
          type:
          - string
          - 'null'
          description: The color to use in the application. Must be a valid hex color code.
        category:
          type:
          - string
          - 'null'
          description: The category of the indicator. Limited to 1,000 characters.
      additionalProperties: false
    Transformation:
      type: object
      properties:
        order:
          type: integer
          format: int32
        required:
          type: boolean
      additionalProperties: false
    ContributionPeriod:
      type: object
      properties:
        date:
          type: string
          format: date-time
        errorFlag:
          type: boolean
        errorText:
          type:
          - string
          - 'null'
        yearOverYear:
          type: number
          format: double
        unexplained:
          type: number
          format: double
        components:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/IndicatorContribution'
      additionalProperties: false
    AggregationMethod:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      type: integer
      format: int32
    Classification:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      type: integer
      format: int32
    Seasonality:
      enum:
      - 0
      - 1
      - 999
      type: integer
      format: int32
    PeriodAlignment:
      enum:
      - 0
      - 1
      - 2
      type: integer
      format: int32
    ScenarioForecastPoints:
      type: object
      properties:
        id:
          type: string
          format: uuid
        scenarioForecastId:
          type: string
          format: uuid
        provider:
          type: string
          format: uuid
        providerId:
          type:
          - string
          - 'null'
        indicatorName:
          type:
          - string
          - 'null'
        lastModified:
          type: string
          format: date-time
        points:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Point'
        offset:
          type: integer
          format: int32
        includeInAllSegments:
          type: boolean
        isLogged:
          type: boolean
      additionalProperties: false
    ForecastModelInfo:
      type: object
      properties:
        id:
          type: string
          description: The id of the model.
          format: uuid
        name:
          type:
          - string
          - 'null'
          description: The name of the model.
        description:
          type:
          - string
          - 'null'
          description: The description of the model.
        indicator:
          $ref: '#/components/schemas/Indicator'
        created:
          type: string
          description: The timestamp in UTC for when the model was created.
          format: date-time
        lastModified:
          type: string
          description: The timestamp in UTC when the model was last saved.
          format: date-time
        owner:
          type:
          - string
          - 'null'
          description: The username of the owner of the model.
        companyName:
          type:
          - string
          - 'null'
          description: The name of the company the model belongs to.
        companyPrefix:
          type:
          - string
          - 'null'
          description: The prefix of the company. A shortened name in the application which is used to differentiate between companies.
        calculation:
          $ref: '#/components/schemas/Calculation'
        type:
          $ref: '#/components/schemas/ForecastModelType'
        frequency:
          $ref: '#/components/schemas/Frequency'
        cutOffPeriods:
          type: integer
          description: The target horizon of the model. Any forecasts after the cut off periods will be trimmed.
          format: int32
        active:
          type: boolean
          description: '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:
          type: string
          description: The UUID for the project the model is in.
          format: uuid
        usedAsIndicator:
          type: boolean
          description: A flag to signal that an indicator has been created from the model.
        analysisAsOfDate:
          type: string
          description: 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.
          format: date-time
        logPrimary:
          type: boolean
          description: '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:
          type:
          - string
          - 'null'
          description: The locked model Id.
          format: uuid
        tags:
          type:
          - array
          - 'null'
          items:
            type: string
          description: A list of tags that are assigned to the model.
        entries:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ForecastModelEntry'
          description: A list of the entries that are in the model. Includes hidden indicators as well.
        lockedModel:
          $ref: '#/components/schemas/LockedModelInfo'
        url:
          type:
          - string
          - 'null'
          description: The link to the model in the application.
        parentType:
          type:
          - string
          - 'null'
          description: The parent type of the model. Currently only parent type is a 'predict'
        parentId:
          type: string
          description: The UUID of the parent entity of the model.
          format: uuid
        parentUrl:
          type:
          - string
          - 'null'
          description: The URL to the model's parent entity.
        notes:
          type:
          - string
          - 'null'
          description: User entered notes for the model.
        modelState:
          type:
          - string
          - 'null'
          description: 'The state of the model. Currently there are three possible options:



            Draft



            Archive



            Production'
        manual:
          type: boolean
          description: If true, model output was manually entered.
        modelForecastSummary:
          type:
          - string
          - 'null'
          description: For models in the Insights dashboard, an AI generated summary of the forecast.
      additionalProperties: false
      description: '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.'
    IndicatorKey:
      type: object
      properties:
        provider:
          type: string
          description: The ID of the provider for the indicator.
          format: uuid
        providerId:
          type:
          - string
          - 'null'
          description: The provider id of the indicator.
      additionalProperties: false
      description: The provider:providerId pair. This is used to identify an indicator in the system.
    ScenarioCoefficient:
      type: object
      properties:
        id:
          type: string
          format: uuid
        scenarioForecastId:
          type: string
          format: uuid
        provider:
          type: string
          format: uuid
        providerId:
          type:
          - string
          - 'null'
        coefficients:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DoubleEditable'
      additionalProperties: false
    ProviderAccess:
      enum:
      - 0
      - 1
      - 2
      type: integer
      format: int32
    Calculation:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      type: integer
      description: 'The transformation applied to the data.



        Possible options:



        None 1



        PeriodOverPeriod 2



        YearOverYear 3



        ThreePeriodYearOverYear 6'
      format: int32
    DoubleEditable:
      type: object
      properties:
        originalValue:
          type: number
          format: double
        currentValue:
          type: number
          format: double
      additionalProperties: false
    Point:
      type: object
      properties:
        value:
          type: number
          format: double
        date:
          type: string
          format: date-time
        annotation:
          type:
          - string
          - 'null'
        manuallyAdjusted:
          type: boolean
        isForecasted:
          type:
          - boolean
          - 'null'
      additionalProperties: false
    ScenarioForecastListing:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        id:
          type: string
          format: uuid
      additionalProperties: false
    LockedModelInfo:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: The name of the locked model.
        createdOn:
          type: string
          description: When the locked model was created.
          format: date-time
        asOf:
          type:
          - string
          - 'null'
          description: An optional date used to trim the model period.
          format: date-time
        lockedBy:
          type:
          - string
          - 'null'
          description: The user who locked the model.
        lastCheckedBy:
          type:
          - string
          - 'null'
          description: The last user to trigger a model health check.
        modelScoreWhenLocked:
          type: number
          description: The model quality score when the model was locked.
          format: double
        dataEndDateWhenLocked:
          type:
          - string
          - 'null'
          description: The last date in the model period when the model was locked.
          format: date-time
        lastModelCheckupDate:
          type:
          - string
          - 'null'
          description: The last time model health was checked.
          format: date-time
      additionalProperties: false
    IndicatorDataSource:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        url:
          type:
          - string
          - 'null'
        dataSourceType:
          $ref: '#/components/schemas/IndicatorType'
      additionalProperties: false
    ForecastModelType:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      type: integer
      description: 'None: 0



        Rocet: 1



        Multivariate: 2



        SegmentedMultivariate: 3



        WeightedUnivariateRegression: 4


        '
      format: int32
    IndicatorValues:
      type: object
      properties:
        indicator:
          $ref: '#/components/schemas/Indicator'
        leadTime:
          type: integer
          format: int32
        values:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Point'
      additionalProperties: false
    ContributionResult:
      type: object
      properties:
        forecast:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Point'
        componentContributions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/IndicatorValues'
      additionalProperties: false
    Indicator:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        aggregate:
          $ref: '#/components/schemas/AggregationMethod'
        calculation:
          $ref: '#/components/schemas/Calculation'
        color:
          type:
          - string
          - 'null'
        displayInformation:
          $ref: '#/components/schemas/DisplayInformation'
        count:
          type: integer
          format: int32
        created:
          type: string
          format: date-time
        startTime:
          type:
          - string
          - 'null'
          format: date-time
        endTime:
          type:
          - string
          - 'null'
          format: date-time
        transformedStartTime:
          type:
          - string
          - 'null'
          format: date-time
        transformedEndTime:
          type:
          - string
          - 'null'
          format: date-time
        frequency:
          $ref: '#/components/schemas/Frequency'
        deprecated:
          type: boolean
        deprecationReason:
          type:
          - string
          - 'null'
        lastModified:
          type: string
          format: date-time
        provider:
          $ref: '#/components/schemas/Provider'
        providerId:
          type:
          - string
          - 'null'
        seasonality:
          $ref: '#/components/schemas/Seasonality'
        source:
          type:
          - string
          - 'null'
        classification:
          $ref: '#/components/schemas/Classification'
        tags:
          type:
          - array
          - 'null'
          items:
            type: string
        type:
          type:
          - string
          - 'null'
        units:
          type:
          - string
          - 'null'
        accessibility:
          $ref: '#/components/schemas/ProviderAccess'
        periodAlignment:
          $ref: '#/components/schemas/PeriodAlignment'
        path:
          type:
          - string
          - 'null'
        notes:
          type:
          - string
          - 'null'
        citation:
          type:
          - string
          - 'null'
        dataSources:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/IndicatorDataSource'
        industryCodes:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/IndustryCode'
        hasZeroVariance:
          type:
          - boolean
          - 'null'
        interval:
          type:
          - string
          - 'null'
        countryCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    IndustryCode:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
        code:
          type:
          - string
          - 'null'
      additionalProperties: false
    ScenarioLite:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        createdOn:
          type: string
          format: date-time
        lastModified:
          type:
          - string
          - 'null'
          format: date-time
        scenarioForecasts:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ScenarioForecast'
        points:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Point'
      additionalProperties: false
    IndicatorEntry:
      type: object
      properties:
        indicator:
          $ref: '#/components/schemas/Indicator'
        offset:
          type: integer
          format: int32
        values:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Point'
        includeInModel:
          type: boolean
        isLogged:
          type: boolean
        entryId:
          type: string
          format: uuid
        useCoefficientBounds:
          type: boolean
        coefficientLowerBounds:
          type:
          - number
          - 'null'
          format: double
        coefficientUpperBounds:
          type:
          - number
          - 'null'
          format: double
        transformations:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Transformation'
      additionalProperties: false
    VolumeDecompResult:
      type: object
      properties:
        decomps:
          type:
          - object
          - 'null'
          properties:
            Unknown:
              type: array
              items:
                $ref: '#/components/schemas/ContributionPeriod'
            Annual:
              type: array
              items:
                $ref: '#/components/schemas/ContributionPeriod'
            SemiAnnual:
              type: array
              items:
                $ref: '#/components/schemas/ContributionPeriod'
            Quarterly:
              type: array
              items:
                $ref: '#/components/schemas/ContributionPeriod'
            Monthly:
              type: array
              items:
                $ref: '#/components/schemas/ContributionPeriod'
            Weekly:
              type: array
              items:
                $ref: '#/components/schemas/ContributionPeriod'
            Daily:
              type: array
              items:
                $ref: '#/components/schemas/ContributionPeriod'
            Raw:
              type: array
              items:
                $ref: '#/components/schemas/ContributionPeriod'
          additionalProperties: false
        entries:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/IndicatorEntry'
      additionalProperties: false
    ForecastModelEntry:
      type: object
      properties:
        indicator:
          $ref: '#/components/schemas/IndicatorKey'
        displayName:
          type:
          - string
          - 'null'
          description: A user defined name for an indicator.
        displayDescription:
          type:
          - string
          - 'null'
          description: A user defined description for an indicator.
        displayColor:
          type:
          - string
          - 'null'
          description: 'A user defined color for an indicator. A valid six integer hex value with the leading #'
        displayCategory:
          type:
          - string
          - 'null'
          description: A user defined category for the indicator.
        offset:
          type: integer
          description: The number of periods to shift the data when modeling.
          format: int32
        includeInModel:
          type: boolean
          description: A flag used to determine if the indicator should be used when modeling.
        includeInAllSegments:
          type: boolean
          description: '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:
          type: boolean
          description: A flag used to determine if the data for this indicator should be logged transformed.
        transformations:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Transformation'
          description: The series transformations applied to the series of this entry and the order that they are applied
      additionalProperties: false
    ScenarioForecast:
      type: object
      properties:
        id:
          type: string
          format: uuid
        scenarioId:
          type: string
          format: uuid
        name:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        createdOn:
          type: string
          format: date-time
        lastModified:
          type:
          - string
          - 'null'
          format: date-time
        scenarioForecastPoints:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ScenarioForecastPoints'
        forecastResult:
          $ref: '#/components/schemas/ForecastResult'
        contributionResult:
          $ref: '#/components/schemas/ContributionResult'
        volumeDecompResult:
          $ref: '#/components/schemas/VolumeDecompResult'
        scenarioCoefficients:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ScenarioCoefficient'
        forecastModel:
          $ref: '#/components/schemas/ForecastModelInfo'
        trimmedData:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/Point'
      additionalProperties: false
    Frequency:
      enum:
      - 0
      - 1
      - 2
      - 4
      - 12
      - 52
      - 365
      - 1000
      type: integer
      description: 'The frequency of the data.



        Daily: 365



        Weekly: 52



        Monthly: 12



        Quarterly: 4



        SemiAnnual: 2



        Annual: 1'
      format: int32
  securitySchemes:
    api_key:
      type: apiKey
      name: ApiKey
      in: query