Webex · Schema

ViewableStatisticsDTO

Specifies the Statistics that agent of this profile can view.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
organizationId	string	ID of the contact center organization. It is required to define for the following operations - All bulk save operations
id	string	ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.
version	integer	The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.
agentStats	boolean	Indicates whether you want the agents to view their personal statistics in Agent Desktop or not.
accessQueueStats	string	This setting controls whether the agent can view statistics for all or some queues in the Agent Personal Statistics tab.It can take one of these values: ALL — To enable the agent to display statistics
contactServiceQueues	array	This setting should be specified when Access Queue Statistics is SPECIFIC.
loggedInTeamStats	boolean	Indicates whether the agent can view statistics for the team or not.
accessTeamStats	string	This setting controls whether the agent can view statistics for all or some teams in the Agent Personal Statistics tab.It can take one of these values: ALL — To enable the agent to display statistics
teams	array	This setting should be specified when Access Team Statistics is SPECIFIC.
createdTime	integer	Creation time(in epoch millis) of this resource.
lastUpdatedTime	integer	Time(in epoch millis) when this resource was last updated.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ViewableStatisticsDTO",
  "title": "ViewableStatisticsDTO",
  "required": [
    "accessQueueStats",
    "accessTeamStats"
  ],
  "type": "object",
  "properties": {
    "organizationId": {
      "maxLength": 36,
      "minLength": 32,
      "pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$",
      "type": "string",
      "description": "ID of the contact center organization. It is required to define for the following operations - All bulk save operations",
      "format": "uuid",
      "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
    },
    "id": {
      "type": "string",
      "description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
      "example": "93912f11-6017-404b-bf14-5331890b1797"
    },
    "version": {
      "type": "integer",
      "description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
      "format": "int32",
      "example": 1
    },
    "agentStats": {
      "type": "boolean",
      "description": "Indicates whether you want the agents to view their personal statistics in Agent Desktop or not.",
      "example": true
    },
    "accessQueueStats": {
      "type": "string",
      "description": "This setting controls whether the agent can view statistics for all or some queues in the Agent Personal Statistics tab.It can take one of these values:\n\nALL \u2014  To enable the agent to display statistics for all queues.\n\nSPECIFIC \u2014 Select Queues drop-down list to enable the agent to display statistics for specific queues.\n\nNONE \u2014 To prevent the agent from displaying queue statistics.\n\n",
      "example": "SPECIFIC",
      "enum": [
        "SPECIFIC",
        "ALL",
        "PROVISIONED_VALUE",
        "NONE"
      ]
    },
    "contactServiceQueues": {
      "uniqueItems": true,
      "type": "array",
      "description": "This setting should be specified when Access Queue Statistics is SPECIFIC.",
      "example": [
        "apim_queue_516789",
        "apim_queue_6123456"
      ],
      "items": {
        "type": "string",
        "description": "This setting should be specified when Access Queue Statistics is SPECIFIC.",
        "example": "[\"apim_queue_516789\",\"apim_queue_6123456\"]"
      }
    },
    "loggedInTeamStats": {
      "type": "boolean",
      "description": "Indicates whether the agent can view statistics for the team or not.",
      "example": true
    },
    "accessTeamStats": {
      "type": "string",
      "description": "This setting controls whether the agent can view statistics for all or some teams in the Agent Personal Statistics tab.It can take one of these values:\n\nALL \u2014  To enable the agent to display statistics for all teams.\n\nSPECIFIC \u2014 Select Teams drop-down list to enable the agent to display statistics for specific teams.\n\nNONE \u2014 To prevent the agent from displaying teams statistics.\n\n",
      "example": "SPECIFIC",
      "enum": [
        "SPECIFIC",
        "ALL",
        "PROVISIONED_VALUE",
        "NONE"
      ]
    },
    "teams": {
      "uniqueItems": true,
      "type": "array",
      "description": "This setting should be specified when Access Team Statistics is SPECIFIC. ",
      "example": [
        "apim_team_516789",
        "apim_team_6123456"
      ],
      "items": {
        "type": "string",
        "description": "This setting should be specified when Access Team Statistics is SPECIFIC. ",
        "example": "[\"apim_team_516789\",\"apim_team_6123456\"]"
      }
    },
    "createdTime": {
      "type": "integer",
      "description": "Creation time(in epoch millis) of this resource.",
      "format": "int64",
      "readOnly": true,
      "example": 1617536244000
    },
    "lastUpdatedTime": {
      "type": "integer",
      "description": "Time(in epoch millis) when this resource was last updated.",
      "format": "int64",
      "readOnly": true,
      "example": 1617536244000
    }
  },
  "description": " Specifies the Statistics that agent of this profile can view.\n "
}