UpdateSkillProfileAveragesUsingHistoricalData

POST

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

WFM

Calculates the averages for call characteristics using the historical data of the given @skill_profile_sids, @skill_profile_group_sids and org sending the request.
If no @skill_profile_sids are given, it will calculate the averages for all skill profiles for the org sending the request.
If no @skill_profile_group_sids are given, it will calculate the averages for all skill profile groups for the org sending the request.
Averages will be weighted by the number of calls that each historical data interval has.
Once the averages are calculated, they will be updated in the db for those skill profiles.

If a nil @datetime_range is given then the range used will be @training_data_range_end_datetime - @averages_calculation_range_in_months to the @training_data_range_end_datetime from the forecasting parameters.
If @averages_calculation_range_in_months is 0, it will use the @training_data_range_start_datetime as the start datetime of the range.

If @exclude_skill_profiles_with_manual_averages is true, it will exclude skill profiles and groups that have manual averages from the calculation
even if those skill profiles and groups are in @skill_profile_sids or @skill_profile_group_sids respectively.

Errors:

grpc.Internal: error occurs when calculating the averages from the historical data.

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

datetime_range

object (DatetimeRange)

datetime_range

optional

The datetime range of the training data to use to calculate the averages, if a nil range is given the following range is used:
@training_data_range_end_datetime - @averages_calculation_range_in_months to the @training_data_range_end_datetime from the forecasting parameters.
If @averages_calculation_range_in_months is 0, it will use the @training_data_range_start_datetime as the start datetime of the range.

start_datetime

string <date-time>

start_datetime

optional

begining datetime

Examples:

1s1.000340012s

end_datetime

string <date-time>

end_datetime

optional

ending datetime

Examples:

1s1.000340012s

exclude_skill_profiles_with_manual_averages

boolean

exclude_skill_profiles_with_manual_averages

optional

If true, it will exclude skill profiles that have manual averages in them from the calculation (even if those skill profiles are in @skill_profile_sids).
Otherwise they will be included in the calculation.

skill_profile_sids

array[integer <int64> | string]

skill_profile_sids

optional

IDs of the skill profiles to calculate the averages of, if none are sent it calculates it for all skill profiles the org has.

skill_profile_group_sids

array[integer <int64> | string]

skill_profile_group_sids

optional

IDs of the skill profile groups to calculate the averages of, if none are sent it calculates it for all skill profile groups that the org has.

Example

{
  "datetime_range": {
    "start_datetime": "1s",
    "end_datetime": "1s"
  },
  "exclude_skill_profiles_with_manual_averages": true,
  "skill_profile_sids": [
    0
  ],
  "skill_profile_group_sids": [
    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/updateskillprofileaveragesusinghistoricaldata' \
--header 'Content-Type: application/json' \
--data-raw '{
    "datetime_range": {
        "start_datetime": "1s",
        "end_datetime": "1s"
    },
    "exclude_skill_profiles_with_manual_averages": true,
    "skill_profile_sids": [
        0
    ],
    "skill_profile_group_sids": [
        0
    ]
}'

Responses

🟢200OK

application/json

Success

Body

object {0}

Example

{}

🔴500Server Error

CalculateTrainingDataAveragesForSkillProfile

UpdateCallCenterNode