ListHistoricalData

Gets the historical data for the org sending the request and the given @skill_profile_category.
It will look through the client's call history and generate the historical data by using their configured forecasting parameters (historical data period and interval width).
The duration of each interval will be the interval width of the org's forecasting parameters.
It also applies any deltas that the client has stored for the given @skill_profile_category, if the category is a group it will use the deltas of the skill profiles part of that group.
If the client has no historical data, only the deltas will be applied to the returned intervals, all other intervals will have nil averages.
Errors:

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

grpc.NotFound: the @skill_profile_category given is not found for the org.

grpc.Internal: error occurs when getting the historical data.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "skill_profile_sid": 0,
    "skill_profile_category": {
        "skill_profile_category_sid": 0,
        "skill_profile_category_type": "SINGLE_SKILL_PROFILE"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Example

{
    "historical_data_intervals": [
        {
            "start_datetime": "1s",
            "skill_profile_sid": 0,
            "average_speed_of_answer_in_seconds": "string",
            "average_handle_time_in_seconds": "string",
            "average_after_call_work_in_seconds": "string",
            "average_time_to_abort_in_seconds": "string",
            "total_calls": 0,
            "total_abandoned_calls": 0,
            "is_delta": true,
            "original_average_speed_of_answer_in_seconds": "string",
            "original_average_handle_time_in_seconds": "string",
            "original_average_after_call_work_in_seconds": "string",
            "original_average_time_to_abort_in_seconds": "string",
            "original_total_calls": 0,
            "original_total_abandoned_calls": 0,
            "skill_profile_category": {
                "skill_profile_category_sid": 0,
                "skill_profile_category_type": "SINGLE_SKILL_PROFILE"
            },
            "average_talk_time_in_seconds": "string",
            "original_average_talk_time_in_seconds": "string"
        }
    ]
}

🟢200Success