BuildRegressionForecastByInterval

Generates a regression forecast using the provided @regression_template.
It will generate forecast intervals for the skill profiles sids in @skill_profile_sids_to_forecast.
It will use the client's saved forecasting test range as the start datetime and the forecast range as the end datetime of the forecasted data.
It will use the client's saved interval width to divide the resulting forecast intervals.
Errors:

grpc.Invalid: no @skill_profile_sids_to_forecast are given or the @regression_template in the request is invalid.

grpc.Internal: error occurs during the building of the regression forecast.

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 BuildRegressionForecastByInterval RPC

regression_template

object (RegressionTemplate)

regression_template

optional

Template to use to generate the regression forecast

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.

average_speed_of_answer_in_seconds

number <float>

average_speed_of_answer_in_seconds

optional

the following only apply for avgs_processing_type=RegressionForecasterAvgsProcessingType.FIXED_AVERAGES
optional

average_handle_time_in_seconds

number <float>

average_handle_time_in_seconds

deprecated

optional
Deprecated as of Apr/25/2025: use average_talk_time_in_seconds instead.

average_after_call_work_in_seconds

number <float>

average_after_call_work_in_seconds

optional

average_time_to_abort_in_seconds

number <float>

average_time_to_abort_in_seconds

optional

average_talk_time_in_seconds

number <float>

average_talk_time_in_seconds

optional

optional - average talk duration.

skill_profile_sids_to_forecast

array[integer <int64> | string]

skill_profile_sids_to_forecast

optional

IDs of the skill profiles to generate the forecasts,

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
  },
  "average_speed_of_answer_in_seconds": 0,
  "average_handle_time_in_seconds": 0,
  "average_after_call_work_in_seconds": 0,
  "average_time_to_abort_in_seconds": 0,
  "average_talk_time_in_seconds": 0,
  "skill_profile_sids_to_forecast": [
    0
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Message type specifying calls in an interval for a specific skill profile

start_datetime

string <date-time>

start_datetime

optional

Start time of the interval.

Examples:

1s1.000340012s

skill_profile_category

object (SkillProfileCategory)

skill_profile_category

optional

Skill profile category that the interval belongs to.

skill_profile_category_type

enum<string>

skill_profile_category_type

optional

Category type for @skill_profile_category_sid.

Allowed values:

SINGLE_SKILL_PROFILESKILL_PROFILE_GROUP

skill_profile_category_sid

integer <int64> | string

skill_profile_category_sid

optional

ID of either a skill profile or a skill profile group determined by @skill_profile_category_type.

total_calls

integer <int32>

total_calls

optional

the number of calls in this interval with this skill profile (answered + unanswered).

average_speed_of_answer_in_seconds

number <float>

average_speed_of_answer_in_seconds

optional

average_handle_time_in_seconds

number <float>

average_handle_time_in_seconds

deprecated

optional
Deprecated as of Apr/25/2025: use average_talk_time_in_seconds instead.

average_after_call_work_in_seconds

number <float>

average_after_call_work_in_seconds

optional

average_time_to_abort_in_seconds

number <float>

average_time_to_abort_in_seconds

optional

total_abandoned_calls

integer <int32>

total_abandoned_calls

optional

the number of abandoned calls in this interval for this skill profile.

is_delta

boolean

is_delta

optional

Whether the interval has been modified or not

interval_width_in_minutes

integer <int32>

interval_width_in_minutes

optional

Interval width minutes that the interval used on creation.
Only set for forecast intervals.

average_talk_time_in_seconds

number <float>

average_talk_time_in_seconds

optional

optional - average talk duration of answered calls.

skill_profile_sid

integer <int64> | string

skill_profile_sid

deprecated

ID of the skill profile to forecast for (not set in profile forecasts).
Deprecated as of Sep/8/2023: use skill_profile_category instead.

forecast_data_interval_sid

integer <int64> | string

forecast_data_interval_sid

optional

ID of the forecast interval that the delta/interval belongs to

Example

{
  "start_datetime": "1s",
  "skill_profile_category": {
    "skill_profile_category_type": "SINGLE_SKILL_PROFILE",
    "skill_profile_category_sid": 0
  },
  "total_calls": 0,
  "average_speed_of_answer_in_seconds": 0,
  "average_handle_time_in_seconds": 0,
  "average_after_call_work_in_seconds": 0,
  "average_time_to_abort_in_seconds": 0,
  "total_abandoned_calls": 0,
  "is_delta": true,
  "interval_width_in_minutes": 0,
  "average_talk_time_in_seconds": 0,
  "skill_profile_sid": 0,
  "forecast_data_interval_sid": 0
}

🔴500Server Error