Help Desk

Submit a ticket My Tickets
Welcome
Login

Prevedere Command Reference

Connector to Prevedere via the Rest API

Connections

Prevedere

Connection to Prevedere via an API key

Inputs

Input Type Detail Notes
API Key TextField The Prevedere API key for the API user

Commands

Get Client Dimensions

Retrieves a list of Dimensions

Inputs

None

Outputs

Output Output Type Notes
Dimensions File

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error executing the command
2 Error Error authenticating

Get Correlation

Retrieves a correlation between a leading and fixed indicator

Inputs

Input Type Detail Notes
Fixed Provider TextField The name or ID of the Fixed Provider. If this value is an ID be sure to check the By ID? input
Fixed Provider By ID? BooleanField Check this if the value of the Fixed Provider input is the model ID
Fixed Provider ID TextField Th Provider ID to use within the Fixed Provider selected
Leading Provider TextField The name or ID of the Leading Provider. If this value is an ID be sure to check the By ID? input
Leading Provider By ID? BooleanField Check this if the value of the Leading Provider input is the model ID
Leading Provider ID TextField Th Provider ID to use within the Leading Provider selected
Calculation DropdownField The calculation to use
Frequency DropdownField The frequency to use

Outputs

Output Output Type Notes
Correlation File

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error executing the command
2 Error Error authenticating

Get Forecast Models

Retrieves a list of Forecast Models

Inputs

None

Outputs

Output Output Type Notes
Forecast Models File

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error executing the command
2 Error Error authenticating

Get Forecast Risk

Retrieves a forecast risk for a model

Inputs

Input Type Detail Notes
Model TextField The name or ID of the model. If this value is an ID be sure to check the By ID? input
By ID? BooleanField Check this if the value of the Model input is the model ID
As of Date TextField The date to scope the forecast to

Outputs

Output Output Type Notes
Forecast Risk File

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error executing the command
2 Error Error authenticating

Get Forecast Risk Growth

Retrieves a forecast risk growth for a model

Inputs

Input Type Detail Notes
Model TextField The name or ID of the model. If this value is an ID be sure to check the By ID? input
By ID? BooleanField Check this if the value of the Model input is the model ID
As of Date TextField The date to scope the forecast to

Outputs

Output Output Type Notes
Forecast Risk Growth File

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error executing the command
2 Error Error authenticating

Get Forecast Statistics

Retrieves a forecast statistics

Inputs

Input Type Detail Notes
Model TextField The name or ID of the model. If this value is an ID be sure to check the By ID? input
By ID? BooleanField Check this if the value of the Model input is the model ID
As of Date TextField The date to scope the forecast to

Outputs

Output Output Type Notes
Forecast Statistics File

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error executing the command
2 Error Error authenticating

Get Forecast by Model

Retrieves a forecast for a model

Inputs

Input Type Detail Notes
Model TextField The name or ID of the model. If this value is an ID be sure to check the By ID? input
By ID? BooleanField Check this if the value of the Model input is the model ID
As of Date TextField The date to scope the forecast to

Outputs

Output Output Type Notes
Forecast File

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error executing the command
2 Error Error authenticating

Get Indicator

Retrieves an indicator

Inputs

Input Type Detail Notes
Provider TextField The name or ID of the Provider. If this value is an ID be sure to check the By ID? input
Provider By ID? BooleanField Check this if the value of the Provider input is the model ID
Provider ID TextField The provider ID to use within the provider selected

Outputs

Output Output Type Notes
Indicator File

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error executing the command
2 Error Error authenticating

Get Indicator Series

Retrieves an indicator series

Inputs

Input Type Detail Notes
Provider TextField The name or ID of the Provider. If this value is an ID be sure to check the By ID? input
Provider By ID? BooleanField Check this if the value of the Provider input is the model ID
Provider ID TextField The provider ID to use within the provider selected
Calculation DropdownField The calculation to use
Frequency DropdownField The frequency to use
Start Date TextField The start date for the series
End Date TextField The end date of the series
Offset NumberField The offset to apply to the series

Outputs

Output Output Type Notes
Indicator Series File

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error executing the command
2 Error Error authenticating

Get Model Contribution

Retrieves a model contribution

Inputs

Input Type Detail Notes
Model TextField The name or ID of the model. If this value is an ID be sure to check the By ID? input
By ID? BooleanField Check this if the value of the Model input is the model ID
As of Date TextField The date to scope the results to

Outputs

Output Output Type Notes
Model Contribution File

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error executing the command
2 Error Error authenticating

Get Model Impact

Retrieves a model's impact

Inputs

Input Type Detail Notes
Model TextField The name or ID of the model. If this value is an ID be sure to check the By ID? input
By ID? BooleanField Check this if the value of the Model input is the model ID
As of Date TextField The date to scope the results to

Outputs

Output Output Type Notes
Model Impact File

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error executing the command
2 Error Error authenticating

Get Providers

Retrieves a list of Providers

Inputs

None

Outputs

Output Output Type Notes
Providers File

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error executing the command
2 Error Error authenticating

Get Raw Model

Retrieves raw model data

Inputs

Input Type Detail Notes
Model TextField The name or ID of the model. If this value is an ID be sure to check the By ID? input
By ID? BooleanField Check this if the value of the Model input is the model ID
As of Date TextField The date to scope the results to
Use Frequency BooleanField Whether or not to use frequency
Exclude Indicators BooleanField Whether or not to exclude indicators

Outputs

Output Output Type Notes
Raw Model File

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error executing the command
2 Error Error authenticating

Import Client Data

Imports data

Inputs

Input Type Detail Notes
Dimension Group TextField The name or ID of the Dimension Group. If this value is an ID be sure to check the By ID? input
By ID? BooleanField Check this if the value of the Dimension Group input is the model ID
Delete existing data? BooleanField Whether or not to delete existing data
Replace existing data? BooleanField Whether or not to replace existing data that matches
Data FileField A comma-separated CSV with the data records to import

Outputs

Output Output Type Notes
Success String
Message String

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error executing the command
2 Error Error authenticating

Validate Client Data

Validates data that could be used for a data import

Inputs

Input Type Detail Notes
Dimension Group TextField The name or ID of the Dimension Group. If this value is an ID be sure to check the By ID? input
By ID? BooleanField Check this if the value of the Dimension Group input is the model ID
Delete existing data? BooleanField Whether or not to delete existing data
Replace existing data? BooleanField Whether or not to replace existing data that matches
Data FileField A comma-separated CSV with the data records to import

Outputs

Output Output Type Notes
Success String
Message String

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error executing the command
2 Error Error authenticating
B
Brian is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.