Webex · Schema

MetaDataPagedUser

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
orgid string ID of the contact center organization. This field is required for all bulk save operations.
page integer Current page number.
pageSize integer Page size for current data set.
totalPages integer Number of pages.
totalRecords integer Total number of items.
links object
actualBurnoutInclusionCount integer Indicates the actual count of Agents selected for Agent burnout detection, including restricted agents that are not visible to requesting user.
actualAutoCSATCount integer Indicates the actual count of Agents selected for Auto CSAT scores, including restricted agents that are not visible to requesting user.
actualSummariesCount integer Indicates the actual count of Agents selected for Generated Summaries, including restricted agents that are not visible to requesting user.
View JSON Schema on GitHub

JSON Schema

webex-metadatapageduser-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/MetaDataPagedUser",
  "title": "MetaDataPagedUser",
  "type": "object",
  "properties": {
    "orgid": {
      "type": "string",
      "description": "ID of the contact center organization. This field is required for all bulk save operations.",
      "example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
    },
    "page": {
      "type": "integer",
      "format": "int32",
      "description": "Current page number.",
      "example": 1
    },
    "pageSize": {
      "type": "integer",
      "format": "int32",
      "description": "Page size for current data set.",
      "example": 20
    },
    "totalPages": {
      "type": "integer",
      "format": "int32",
      "description": "Number of pages.",
      "example": 5
    },
    "totalRecords": {
      "type": "integer",
      "format": "int64",
      "description": "Total number of items.",
      "example": 100
    },
    "links": {
      "type": "object",
      "$ref": "#/components/schemas/PaginationLinks",
      "additionalProperties": {
        "type": "string"
      }
    },
    "actualBurnoutInclusionCount": {
      "type": "integer",
      "format": "int64",
      "description": "Indicates the actual count of Agents selected for Agent burnout detection, including restricted agents that are not visible to requesting user.",
      "example": 100
    },
    "actualAutoCSATCount": {
      "type": "integer",
      "format": "int64",
      "description": "Indicates the actual count of Agents selected for Auto CSAT scores, including restricted agents that are not visible to requesting user.",
      "example": 100
    },
    "actualSummariesCount": {
      "type": "integer",
      "format": "int64",
      "description": "Indicates the actual count of Agents selected for Generated Summaries, including restricted agents that are not visible to requesting user.",
      "example": 100
    }
  }
}