To interact with Prevedere® as part of a chain, such as to retrieve predictive analytics or import client data, add a command using a Prevedere connector.
To enable these commands, an IT admin first creates a Prevedere connector.
Get Client Dimensions
To retrieve a list of dimensions, add a Get Client Dimensions command.
Properties
None
Outputs
Output |
Output Type |
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
To retrieve a correlation between leading and fixed indicators, add a Get Correlation command.
Properties
Property |
Detail |
Fixed Provider |
Enter the name or ID of the fixed provider to include in the correlation. If an ID, also check Fixed Provider by ID?. |
Fixed Provider By ID? |
If the Fixed Provider property is an ID, check this box. |
Fixed Provider ID |
Enter the ID of the provider to use within the Fixed Provider property. |
Leading Provider |
Enter the name or ID of the leading provider to include in the correlation. If an ID, also check Leading Provider by ID?. |
Leading Provider By ID? |
If the Leading Provider property is an ID, check this box. |
Leading Provider ID |
Enter the ID of the provider to use within the Leading Provider property. |
Calculation |
Select the calculation to use with the correlation. |
Frequency |
Select the frequency of the correlation. |
Outputs
Output |
Output Type |
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
To retrieve a list of forecast models, add a Get Forecast Models command.
Properties
None
Outputs
Output |
Output Type |
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
To retrieve a forecast risk for a model, add a Get Forecast Risk command.
Properties
Property |
Detail |
Model |
Enter the name or ID of the model to retrieve a forecast risk for. If an ID, also check By ID?. |
By ID? |
If the Model property is an ID, check this box. |
As Of Date |
Enter the date to scope the forecast to. |
Outputs
Output |
Output Type |
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
To retrieve a forecast risk growth for a model, add a Get Forecast Risk Growth command.
Properties
Property |
Detail |
Model |
Enter the name or ID of the model to retrieve a forecast risk growth for. If an ID, also check By ID?. |
By ID? |
If the Model property is an ID, check this box. |
As Of Date |
Enter the date to scope the forecast to. |
Outputs
Output |
Output Type |
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
To retrieve forecast statistics for a model, add a Get Forecast Statistics command.
Properties
Property |
Detail |
Model |
Enter the name or ID of the model to retrieve forecast statistics for. If an ID, also check By ID?. |
By ID? |
If the Model property is an ID, check this box. |
As Of Date |
Enter the date to scope the forecast to. |
Outputs
Output |
Output Type |
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
To retrieve a forecast for a model, add a Get Forecast by Model command.
Properties
Property |
Detail |
Model |
Enter the name or ID of the model to retrieve a forecast for. If an ID, also check By ID?. |
By ID? |
If the Model property is an ID, check this box. |
As Of Date |
Enter the date to scope the forecast to. |
Outputs
Output |
Output Type |
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
To retrieve an indicator for a provider, add a Get Indicator command.
Properties
Property |
Detail |
Provider |
Enter the name or ID of the provider to retrieve an indicator for. If an ID, also check Provider By ID?. |
Provider By ID? |
If the Provider property is an ID, check this box. |
Provider ID |
Enter the ID of the provider to use within the Provider property. |
Outputs
Output |
Output Type |
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
To retrieve an indicator series for a provider, add a Get Indicator Series command.
Properties
Property |
Detail |
Provider |
Enter the name or ID of the provider to retrieve an indicator series for. If an ID, also check Provider By ID?. |
Provider By ID? |
If the Provider property is an ID, check this box. |
Provider ID |
Enter the ID of the provider to use within the Provider property. |
Calculation |
Select the calculation to use with the indicator series. |
Frequency |
Select the frequency of the indicator series. |
Start Date |
Enter the start date of the series. |
End Date |
Enter the end date of the series. |
Offset |
Enter the offset to apply to the series. |
Outputs
Output |
Output Type |
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
To retrieve a model's contribution, add a Get Model Contribution command.
Properties
Property |
Detail |
Model |
Enter the name or ID of the model to retrieve a contribution for. If an ID, also check By ID?. |
By ID? |
If the Model property is an ID, check this box. |
As Of Date |
Enter the date to scope the contribution to. |
Outputs
Output |
Output Type |
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
To retrieve a model's impact, add a Get Model Impact command.
Properties
Property |
Detail |
Model |
Enter the name or ID of the model to retrieve an impact for. If an ID, also check By ID?. |
By ID? |
If the Model property is an ID, check this box. |
As Of Date |
Enter the date to scope the impact to. |
Outputs
Output |
Output Type |
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
To retrieve a list of providers, add a Get Providers command.
Properties
None
Outputs
Output |
Output Type |
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
To retrieve raw model data, add a Get Raw Model command.
Properties
Property |
Detail |
Model |
Enter the name or ID of the model to retrieve the raw data for. If an ID, also check By ID?. |
By ID? |
If the Model property is an ID, check this box. |
As Of Date |
Enter the date to scope the raw model to. |
Use Frequency |
To use the frequency in the raw model, check this box. |
Exclude Indicators |
To exclude indicators from the raw model, check this box. |
Outputs
Output |
Output Type |
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
To import a comma-separated values (CSV) file of client data into a dimension group, add an Import Client Data command.
Properties
Property |
Detail |
Dimension Group |
Enter the name or ID of the dimension group to import the data into. If an ID, also check By ID?. |
By ID? |
If the Dimension Group property is an ID, check this box. |
Delete existing data? |
To delete any existing client data from the dimension group upon import, check this box. |
Replace existing data? |
To replace any existing client data that matches imported data, check this box. |
Data |
Upload a CSV with the client records to import. |
Outputs
Output |
Output Type |
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
To validate client data before an import, add a Validate Client Data command.
Properties
Property |
Detail |
Dimension Group |
Enter the name or ID of the dimension group to validate the data for. If an ID, also check By ID?. |
By ID? |
If the Dimension Group property is an ID, check this box. |
Delete existing data? |
To delete any existing client data from the dimension group upon import, check this box. |
Replace existing data? |
To replace any existing client data that matches imported data, check this box. |
Data |
Upload a CSV with the client records to validate. |
Outputs
Output |
Output Type |
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 |