CreateRegressionTemplate

POST

https://api.cbf.tcn.com/api/v1alpha1/wfm/createregressiontemplate

Creates an entry for the @regression_template for the requesting org.
Errors:

grpc.Invalid: the @regression_template in the request is invalid.

grpc.Internal: error occurs when creating the regression template.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

Request message for the CreateRegressionTemplate RPC

regression_template

object (RegressionTemplate)

regression_template

optional

Regression template to be stored in the db.

model_type

enum<string>

model_type

optional

Selected algorithmic method to be used

Allowed values:

RANDOM_FORESTADABOOSTGRADIENT_BOOSTINGLINEAR_REGRESSIONLINEAR_AVGSEGMENTED_LINEARMLPAUTO

avgs_processing_type

enum<string>

avgs_processing_type

optional

Processing type for the averages.

Allowed values:

FORECASTAVERAGESFIXED_AVERAGES

name

string

name

optional

Name of the regression template.

exclude_call_data_for_n_weeks

integer <int32>

exclude_call_data_for_n_weeks

optional

Number of weeks of training data to exclude when building a forecast.

num_weeks_ago_to_emphasize

integer <int32>

num_weeks_ago_to_emphasize

optional

Number of weeks in the past to emphasize;

max_deviation

number <float>

max_deviation

optional

Value that especificies the max value of deviations to use. Greater deviations than the specified values will be excluded.
optional

trend_sensitivity

number <float>

trend_sensitivity

optional

Percentage from 0 to 100 that specifies the trend sensitivity.

exclude_intervals_with_no_calls

boolean

exclude_intervals_with_no_calls

optional

Whether or not to exclude intervals with no calls.

include_seasonality

boolean

include_seasonality

optional

Whether or not to include seasonality.

include_trend

boolean

include_trend

optional

Whether or not to include trend.

regression_template_sid

integer <int64> | string

regression_template_sid

optional

ID of the regression template.

Example

{
    "regression_template": {
        "model_type": "RANDOM_FOREST",
        "avgs_processing_type": "FORECAST",
        "name": "string",
        "exclude_call_data_for_n_weeks": 0,
        "num_weeks_ago_to_emphasize": 0,
        "max_deviation": 0,
        "trend_sensitivity": 0,
        "exclude_intervals_with_no_calls": true,
        "include_seasonality": true,
        "include_trend": true,
        "regression_template_sid": 0
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/wfm/createregressiontemplate' \
--header 'Content-Type: application/json' \
--data-raw '{
    "regression_template": {
        "model_type": "RANDOM_FOREST",
        "avgs_processing_type": "FORECAST",
        "name": "string",
        "exclude_call_data_for_n_weeks": 0,
        "num_weeks_ago_to_emphasize": 0,
        "max_deviation": 0,
        "trend_sensitivity": 0,
        "exclude_intervals_with_no_calls": true,
        "include_seasonality": true,
        "include_trend": true,
        "regression_template_sid": 0
    }
}'

Responses

🟢200OK

application/json

Success

Body

object {0}

Example

{}

🔴500Server Error

Modified at 2025-07-10 17:42:28

DeleteCallProfileTemplate

DeleteRegressionTemplate