GetForecastingParameters

Gets the forecasting parameters for the org sending the request.
If the org hasn't created any parameters, it will return the default parameters.
Errors:

grpc.Internal: error occurs when getting the parameters.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

application/json

Success

Body

Response message for the GetForecastingParameters RPC.

forecasting_parameters

optional

parameters used for forecasts and training data samples.

interval_width_in_minutes

integer <int32>

interval_width_in_minutes

optional

number of minutes in which calls will be grouped together during for the duration of a forecast, must be a multiple of 5 ranging from 5 to 60.

forecast_test_range_in_weeks

integer <int32>

forecast_test_range_in_weeks

optional

number of weeks of the training data from the current datetime to use as a forecast test range.

averages_calculation_range_in_months

integer <int32>

averages_calculation_range_in_months

optional

Number of months of training data to use when calculating averages.
If set to 0, then all the training data will be used when calculating the averages,
meaning that the start datetime of the training data to use will be the start datetime of the @training_data_range.
Otherwise, it will subtract that many months from the @training_data_range end datetime and use it as the start time.

training_data_datetime_range

object

DatetimeRange

required

historical_data_range_in_months

integer <int32>

historical_data_range_in_months

required

number of months back from the current datetime to look up history.

forecast_datetime_range

object

DatetimeRange

required

Example

{
  "forecasting_parameters": {
    "interval_width_in_minutes": 0,
    "forecast_test_range_in_weeks": 0,
    "averages_calculation_range_in_months": 0,
    "forecast_datetime_range": {
      "start_datetime": "1s",
      "end_datetime": "1s"
    },
    "historical_data_range_in_months": 0,
    "training_data_datetime_range": {
      "start_datetime": "1s",
      "end_datetime": "1s"
    }
  }
}

GetForecastingParameters

Request

Request samples

Responses