ListTopSkillProfiles

Gets the top N skill profiles with the highest calls_count for org sending the request where N is @max_number_of_profiles.
It will also return the number of skills found for that profile.
Individual skills that each profile has will not be returned.
Errors:

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

grpc.Internal: error occurs when getting the skill profiles.

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 ListTopSkillProfiles RPC.

max_number_of_profiles

integer <int32>

max_number_of_profiles

optional

max number of top skill profiles to get.

Example

{
  "max_number_of_profiles": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Response message for the ListTopSkillProfiles RPC.

skill_profiles

array[object (SkillProfile) {17}]

skill_profiles

optional

skill profiles found for the given parameters.

create_date

string <date-time>

create_date

optional

date of creation of the skill profile.

Examples:

1s1.000340012s

inactive_as_of_date

string <date-time>

inactive_as_of_date

optional

date that the profile became inactive, if not set, then the profile is currently active.

Examples:

1s1.000340012s

sms

object (SmsMetadata)

sms

optional

metadata related to sms conversations.

name

string

name

optional

name of the skill profile.

description

string

description

optional

description about the skill profile.

unnamed

boolean

unnamed

optional

indicates whether the autogenerated name of the skill profile has been modified by the org.

skills

array[object (Skill) {6}]

skills

optional

skills of the skill profile.

skills_count

integer <int32>

skills_count

optional

number of skills that this skill profile has.

occurrence

number <float>

occurrence

optional

percentage of total calls that had this skill profile.

average_speed_of_answer_in_seconds

number <float>

average_speed_of_answer_in_seconds

optional

average time that calls took to be answered.

average_handle_time_in_seconds

number <float>

average_handle_time_in_seconds

deprecated

average duration of answered calls.
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 that agents spent in wrap up.

average_time_to_abort_in_seconds

number <float>

average_time_to_abort_in_seconds

optional

average time that callers waited before hanging unanswered calls.

are_averages_manual

boolean

are_averages_manual

optional

indicates whether or not the averages were manually entered by the user (if false then the averages were automatically calculated from the historical data).

channel_types

array[string]

channel_types

optional

specifies what channels this skill profile applies to.

Allowed values:

CHANNEL_TYPE_EMAILCHANNEL_TYPE_SMSCHANNEL_TYPE_CHATCHANNEL_TYPE_VOICECHANNEL_TYPE_WHATSAPP

average_talk_time_in_seconds

number <float>

average_talk_time_in_seconds

optional

average talk duration of answered calls.

skill_profile_sid

integer <int64> | string

skill_profile_sid

optional

ID of the skill profile.

Example

{
  "skill_profiles": [
    {
      "create_date": "1s",
      "inactive_as_of_date": "1s",
      "sms": {
        "average_conversation_length": "string"
      },
      "name": "string",
      "description": "string",
      "unnamed": true,
      "skills": [
        {
          "client_skill_type": "AGENT_SKILL",
          "delete_date": "1s",
          "name": "string",
          "proficiency": 0,
          "skill_sid": 0,
          "client_skill_sid": 0
        }
      ],
      "skills_count": 0,
      "occurrence": 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,
      "are_averages_manual": true,
      "channel_types": [
        "CHANNEL_TYPE_EMAIL"
      ],
      "average_talk_time_in_seconds": 0,
      "skill_profile_sid": 0
    }
  ]
}

🔴500Server Error