GetDashboardQueuePreferences

GetDashboardQueuePreferences returns the Dashboard Queue table preferences.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

Request for GetDashboardQueuePreferences

field_mask

string

field_mask

optional

Mask containing list of desired fields.

Example

{
    "field_mask": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Response for GetDashboardQueuePreferences

dashboard_queue_preferences

object (DashboardQueuePreferences)

dashboard_queue_preferences

optional

The requested preferences.

default_info_sort_by_value

enum<string>

default_info_sort_by_value

optional

Default Queue/Hold Info Sort-By Value

Allowed values:

QUEUE_INFO_SORT_BY_NONEQUEUE_INFO_SORT_BY_AVERAGE_LENGTHQUEUE_INFO_SORT_BY_CALL_COUNTQUEUE_INFO_SORT_BY_CALL_SKILLSQUEUE_INFO_SORT_BY_CALL_TYPEQUEUE_INFO_SORT_BY_MAXIMUM_LENGTHQUEUE_INFO_SORT_BY_QUEUED_NOTIFICATION_TYPE

default_info_view

boolean

default_info_view

optional

Default Queue/Hold table view. 'false' for icon view, 'true' for table view.

default_info_grouping

boolean

default_info_grouping

optional

Default Queue/Hold table grouping. 'false' for no grouping, 'true' for group by queue type.

default_small_icon

boolean

default_small_icon

optional

Default table icon size. 'true' for small, 'false' for large.

default_descending_sort

boolean

default_descending_sort

optional

Default table sort direction. 'false' for descending, 'true' for ascending.

default_agent_skills_filter

integer <int64> | string

default_agent_skills_filter

optional

Default skills filter. Holds a regional sid pointing to the filter in the xml_client_property table. Default is no filtering ('-1').

default_info_table_template

integer <int64> | string

default_info_table_template

optional

Default table template. Holds a regional sid pointing to the filter in the xml_client_property table. Default is no filtering ('0').

Example

{
    "dashboard_queue_preferences": {
        "default_info_sort_by_value": "QUEUE_INFO_SORT_BY_NONE",
        "default_info_view": true,
        "default_info_grouping": true,
        "default_small_icon": true,
        "default_descending_sort": true,
        "default_agent_skills_filter": 0,
        "default_info_table_template": 0
    }
}

🔴500Server Error