latestOpenAPI 3.0.12026-08-1163117239.4 KB

c5ac8232e334

ForecastModel

Retrieves information for a single model given the ID

This endpoint is used to pull information about an individual model accessible to the API key.

The response includes model metadata, information about the dependent variable or Primary Indicator and independent or Explanatory Indicators including offsets and display values.

get/forecastmodel/{ForecastModelId}

Path parameters

ForecastModelIdstring uuid required

Response

idstring uuid

The id of the model.

namestring nullable

The name of the model.

descriptionstring nullable

The description of the model.

createdstring date-time

The timestamp in UTC for when the model was created.

lastModifiedstring date-time

The timestamp in UTC when the model was last saved.

ownerstring nullable

The username of the owner of the model.

companyNamestring nullable

The name of the company the model belongs to.

companyPrefixstring nullable

The prefix of the company. A shortened name in the application which is used to differentiate between companies.

calculation0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8

The transformation applied to the data.

Possible options:

None 1

PeriodOverPeriod 2

YearOverYear 3

ThreePeriodYearOverYear 6

type0 | 1 | 2 | 3 | 4

None: 0

Rocet: 1

Multivariate: 2

SegmentedMultivariate: 3

WeightedUnivariateRegression: 4

frequency0 | 1 | 2 | 4 | 12 | 52 | 365 | 1000

The frequency of the data.

Daily: 365

Weekly: 52

Monthly: 12

Quarterly: 4

SemiAnnual: 2

Annual: 1

cutOffPeriodsinteger

The target horizon of the model. Any forecasts after the cut off periods will be trimmed.

activeboolean

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.

projectIdstring uuid

The UUID for the project the model is in.

usedAsIndicatorboolean

A flag to signal that an indicator has been created from the model.

analysisAsOfDatestring 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.

logPrimaryboolean

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.

activeLockedModelstring uuid nullable

The locked model Id.

tagsstring[] nullable

A list of tags that are assigned to the model.

urlstring nullable

The link to the model in the application.

parentTypestring nullable

The parent type of the model. Currently only parent type is a 'predict'

parentIdstring uuid

The UUID of the parent entity of the model.

parentUrlstring nullable

The URL to the model's parent entity.

notesstring nullable

User entered notes for the model.

modelStatestring nullable

The state of the model. Currently there are three possible options:

Draft