swagger: '2.0'
info:
  description: With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
  version: v2
  title: PureCloud Platform Agent Assistants Analytics API
  termsOfService: https://help.genesys.cloud/articles/terms-and-conditions/
  contact:
    name: PureCloud Developer Evangelists
    url: https://developer.genesys.cloud/
    email: DeveloperEvangelists@genesys.com
  license:
    name: UNLICENSED
    url: https://help.genesys.cloud/articles/terms-and-conditions/
host: api.mypurecloud.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: Analytics
  description: Analytics querying and reporting.
  externalDocs:
    description: Analytics Documentation
    url: https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis
paths:
  /api/v2/analytics/actions/aggregates/jobs:
    post:
      tags:
      - Analytics
      summary: Query for action aggregates asynchronously
      description: ''
      operationId: postAnalyticsActionsAggregatesJobs
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/ActionAsyncAggregationQuery'
      responses:
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - integrations:action:view
        - bridge:actions:view
      x-purecloud-method-name: postAnalyticsActionsAggregatesJobs
  /api/v2/analytics/actions/aggregates/jobs/{jobId}:
    get:
      tags:
      - Analytics
      summary: Get status for async query for action aggregates
      description: ''
      operationId: getAnalyticsActionsAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - integrations:action:view
        - bridge:actions:view
      x-purecloud-method-name: getAnalyticsActionsAggregatesJob
    delete:
      tags:
      - Analytics
      summary: Delete/cancel an async request for action aggregates
      description: ''
      operationId: deleteAnalyticsActionsAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '204':
          description: Deleted
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - integrations:action:view
        - bridge:actions:view
      x-purecloud-method-name: deleteAnalyticsActionsAggregatesJob
  /api/v2/analytics/actions/aggregates/query:
    post:
      tags:
      - Analytics
      summary: Query for action aggregates
      description: ''
      operationId: postAnalyticsActionsAggregatesQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/ActionAggregationQuery'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ActionAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - integrations:action:view
        - bridge:actions:view
      x-purecloud-method-name: postAnalyticsActionsAggregatesQuery
  /api/v2/analytics/actions/aggregates/jobs/{jobId}/results:
    get:
      tags:
      - Analytics
      summary: Fetch a page of results for an async aggregates query
      description: ''
      operationId: getAnalyticsActionsAggregatesJobResults
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      - name: cursor
        in: query
        description: Cursor token to retrieve next page
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ActionAsyncAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - integrations:action:view
        - bridge:actions:view
      x-purecloud-method-name: getAnalyticsActionsAggregatesJobResults
  /api/v2/analytics/agentcopilots/aggregates/query:
    post:
      tags:
      - Analytics
      summary: Query for agent copilot aggregates
      description: ''
      operationId: postAnalyticsAgentcopilotsAggregatesQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/AgentCopilotAggregationQuery'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AgentCopilotAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:agentCopilotAggregate:view
      x-purecloud-method-name: postAnalyticsAgentcopilotsAggregatesQuery
  /api/v2/analytics/agents/{userId}/status:
    get:
      tags:
      - Analytics
      summary: Get an agent and their active sessions by user ID
      description: ''
      operationId: getAnalyticsAgentStatus
      produces:
      - application/json
      parameters:
      - name: userId
        in: path
        description: userId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AnalyticsAgentStateAgentResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:agentState:view
      x-purecloud-method-name: getAnalyticsAgentStatus
  /api/v2/analytics/agents/status/counts:
    post:
      tags:
      - Analytics
      summary: Count agents by different groupings
      description: ''
      operationId: postAnalyticsAgentsStatusCounts
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/AgentStateCountsRequest'
      - name: groupBy
        in: query
        description: Include to choose which groupings to count by and return. If not included it will return only counts grouped by segmentType
        required: false
        type: array
        items:
          type: string
          enum:
          - segmentType
          - presence
          - routingStatus
          - isOutOfOffice
        collectionFormat: multi
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AnalyticsAgentStateCountsResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:agentState:view
      x-purecloud-method-name: postAnalyticsAgentsStatusCounts
  /api/v2/analytics/agents/status/query:
    post:
      tags:
      - Analytics
      summary: Retrieve the top 50 agents matching the query filters
      description: ''
      operationId: postAnalyticsAgentsStatusQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/AgentStateQueryRequest'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AnalyticsAgentStateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:agentState:view
      x-purecloud-method-name: postAnalyticsAgentsStatusQuery
  /api/v2/analytics/bots/aggregates/query:
    post:
      tags:
      - Analytics
      summary: Query for bot aggregates
      description: ''
      operationId: postAnalyticsBotsAggregatesQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/BotAggregationQuery'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/BotAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:botAggregate:view
      x-purecloud-method-name: postAnalyticsBotsAggregatesQuery
  /api/v2/analytics/bots/aggregates/jobs:
    post:
      tags:
      - Analytics
      summary: Query for bot aggregates asynchronously
      description: ''
      operationId: postAnalyticsBotsAggregatesJobs
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/BotAsyncAggregationQuery'
      responses:
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:botAggregate:view
      x-purecloud-method-name: postAnalyticsBotsAggregatesJobs
  /api/v2/analytics/bots/aggregates/jobs/{jobId}:
    get:
      tags:
      - Analytics
      summary: Get status for async query for bot aggregates
      description: ''
      operationId: getAnalyticsBotsAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:botAggregate:view
      x-purecloud-method-name: getAnalyticsBotsAggregatesJob
    delete:
      tags:
      - Analytics
      summary: Delete/cancel an async request for bot aggregates
      description: ''
      operationId: deleteAnalyticsBotsAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '204':
          description: Deleted
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:botAggregate:view
      x-purecloud-method-name: deleteAnalyticsBotsAggregatesJob
  /api/v2/analytics/bots/aggregates/jobs/{jobId}/results:
    get:
      tags:
      - Analytics
      summary: Fetch a page of results for an async aggregates query
      description: ''
      operationId: getAnalyticsBotsAggregatesJobResults
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      - name: cursor
        in: query
        description: Cursor token to retrieve next page
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/BotAsyncAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:botAggregate:view
      x-purecloud-method-name: getAnalyticsBotsAggregatesJobResults
  /api/v2/analytics/casemanagement/aggregates/query:
    post:
      tags:
      - Analytics
      summary: Query for case management aggregates
      description: ''
      operationId: postAnalyticsCasemanagementAggregatesQuery
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/CaseManagementAggregationQuery'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/CaseManagementAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:caseManagementAggregate:view
      x-purecloud-method-name: postAnalyticsCasemanagementAggregatesQuery
  /api/v2/analytics/casemanagement/aggregates/jobs:
    post:
      tags:
      - Analytics
      summary: Query for case management aggregates asynchronously
      description: ''
      operationId: postAnalyticsCasemanagementAggregatesJobs
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/CaseManagementAsyncAggregationQuery'
      responses:
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:caseManagementAggregate:view
      x-purecloud-method-name: postAnalyticsCasemanagementAggregatesJobs
  /api/v2/analytics/casemanagement/aggregates/jobs/{jobId}:
    get:
      tags:
      - Analytics
      summary: Get status for async query for case management aggregates
      description: ''
      operationId: getAnalyticsCasemanagementAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:caseManagementAggregate:view
      x-purecloud-method-name: getAnalyticsCasemanagementAggregatesJob
    delete:
      tags:
      - Analytics
      summary: Delete/cancel an async request for case management aggregates
      description: ''
      operationId: deleteAnalyticsCasemanagementAggregatesJob
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '204':
          description: Deleted
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:caseManagementAggregate:view
      x-purecloud-method-name: deleteAnalyticsCasemanagementAggregatesJob
  /api/v2/analytics/casemanagement/aggregates/jobs/{jobId}/results:
    get:
      tags:
      - Analytics
      summary: Fetch a page of results for an async case management query
      description: ''
      operationId: getAnalyticsCasemanagementAggregatesJobResults
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      - name: cursor
        in: query
        description: Cursor token to retrieve next page
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/CaseManagementAsyncAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:caseManagementAggregate:view
      x-purecloud-method-name: getAnalyticsCasemanagementAggregatesJobResults
  /api/v2/analytics/conversations/aggregates/query:
    post:
      tags:
      - Analytics
      summary: Query for conversation aggregates
      description: ''
      operationId: postAnalyticsConversationsAggregatesQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/ConversationAggregationQuery'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ConversationAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
            general.internal.server.error: An internal server error has occurred.
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:conversationAggregate:view
      x-purecloud-method-name: postAnalyticsConversationsAggregatesQuery
  /api/v2/analytics/conversations/{conversationId}/details:
    get:
      tags:
      - Analytics
      summary: Get a conversation by id
      description: ''
      operationId: getAnalyticsConversationDetails
      produces:
      - application/json
      parameters:
      - name: conversationId
        in: path
        description: conversationId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AnalyticsConversationWithoutAttributes'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:conversationDetail:view
        - analytics:agentConversationDetail:view
      x-purecloud-method-name: getAnalyticsConversationDetails
  /api/v2/analytics/conversations/aggregates/jobs:
    post:
      tags:
      - Analytics
      summary: Query for conversation aggregates asynchronously
      description: ''
      operationId: postAnalyticsConversationsAggregatesJobs
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/ConversationAsyncAggregationQuery'
      responses:
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:conversationAggregate:view
      x-purecloud-method-name: postAnalyticsConversationsAggregatesJobs
  /api/v2/analytics/conversations/aggregates/jobs/{jobId}:
    get:
      tags:
      - Analytics
      summary: Get status for async query for conversation aggregates
      description: ''
      operationId: getAnalyticsConversationsAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:conversationAggregate:view
      x-purecloud-method-name: getAnalyticsConversationsAggregatesJob
    delete:
      tags:
      - Analytics
      summary: Delete/cancel an async request for conversation aggregates
      description: ''
      operationId: deleteAnalyticsConversationsAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '204':
          description: Deleted
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:conversationAggregate:view
      x-purecloud-method-name: deleteAnalyticsConversationsAggregatesJob
  /api/v2/analytics/conversations/aggregates/jobs/{jobId}/results:
    get:
      tags:
      - Analytics
      summary: Fetch a page of results for an async aggregates query
      description: ''
      operationId: getAnalyticsConversationsAggregatesJobResults
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      - name: cursor
        in: query
        description: Cursor token to retrieve next page
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ConversationAsyncAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:conversationAggregate:view
      x-purecloud-method-name: getAnalyticsConversationsAggregatesJobResults
  /api/v2/analytics/conversations/activity/query:
    post:
      tags:
      - Analytics
      summary: Query for conversation activity observations
      description: ''
      operationId: postAnalyticsConversationsActivityQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/ConversationActivityQuery'
      - name: pageSize
        in: query
        description: The desired page size
        required: false
        type: integer
        format: int32
      - name: pageNumber
        in: query
        description: The desired page number
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ConversationActivityResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:queueObservation:view
      x-purecloud-method-name: postAnalyticsConversationsActivityQuery
  /api/v2/analytics/conversations/details/query:
    post:
      tags:
      - Analytics
      summary: Query for conversation details
      description: ''
      operationId: postAnalyticsConversationsDetailsQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/ConversationQuery'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AnalyticsConversationQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            payload.too.large: The response payload was too large.
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
            general.internal.server.error: An internal server error has occurred.
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:conversationDetail:view
        - analytics:agentConversationDetail:view
      x-purecloud-method-name: postAnalyticsConversationsDetailsQuery
  /api/v2/analytics/conversations/details:
    get:
      tags:
      - Analytics
      summary: Gets multiple conversations by id
      description: ''
      operationId: getAnalyticsConversationsDetails
      produces:
      - application/json
      parameters:
      - name: id
        in: query
        description: Comma-separated conversation ids
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AnalyticsConversationWithoutAttributesMultiGetResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:conversationDetail:view
        - analytics:agentConversationDetail:view
      x-purecloud-method-name: getAnalyticsConversationsDetails
  /api/v2/analytics/conversations/{conversationId}/details/properties:
    post:
      tags:
      - Analytics
      summary: Index conversation properties
      description: ''
      operationId: postAnalyticsConversationDetailsProperties
      produces:
      - application/json
      parameters:
      - name: conversationId
        in: path
        description: conversationId
        required: true
        type: string
      - in: body
        name: body
        description: request
        required: true
        schema:
          $ref: '#/definitions/PropertyIndexRequest'
      responses:
        '202':
          description: Accepted - Indexing properties
          schema:
            $ref: '#/definitions/PropertyIndexRequest'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:conversationProperties:index
      x-purecloud-method-name: postAnalyticsConversationDetailsProperties
  /api/v2/analytics/conversations/details/jobs:
    post:
      tags:
      - Analytics
      summary: Query for conversation details asynchronously
      description: ''
      operationId: postAnalyticsConversationsDetailsJobs
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/AsyncConversationQuery'
      responses:
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:conversationDetail:view
        - analytics:agentConversationDetail:view
      x-purecloud-method-name: postAnalyticsConversationsDetailsJobs
  /api/v2/analytics/conversations/details/jobs/{jobId}:
    get:
      tags:
      - Analytics
      summary: Get status for async query for conversation details
      description: ''
      operationId: getAnalyticsConversationsDetailsJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:conversationDetail:view
        - analytics:agentConversationDetail:view
      x-purecloud-method-name: getAnalyticsConversationsDetailsJob
    delete:
      tags:
      - Analytics
      summary: Delete/cancel an async details job
      description: ''
      operationId: deleteAnalyticsConversationsDetailsJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '204':
          description: Deleted
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:conversationDetail:view
        - analytics:agentConversationDetail:view
      x-purecloud-method-name: deleteAnalyticsConversationsDetailsJob
  /api/v2/analytics/conversations/details/jobs/{jobId}/results:
    get:
      tags:
      - Analytics
      summary: Fetch a page of results for an async details job
      description: ''
      operationId: getAnalyticsConversationsDetailsJobResults
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      - name: cursor
        in: query
        description: Indicates where to resume query results (not required for first page)
        required: false
        type: string
      - name: pageSize
        in: query
        description: The desired maximum number of results
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AnalyticsConversationAsyncQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:conversationDetail:view
        - analytics:agentConversationDetail:view
      x-purecloud-method-name: getAnalyticsConversationsDetailsJobResults
  /api/v2/analytics/conversations/details/jobs/availability:
    get:
      tags:
      - Analytics
      summary: Lookup the datalake availability date and time
      description: ''
      operationId: getAnalyticsConversationsDetailsJobsAvailability
      produces:
      - application/json
      parameters: []
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/DataAvailabilityResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:conversationDetail:view
      x-purecloud-method-name: getAnalyticsConversationsDetailsJobsAvailability
  /api/v2/analytics/evaluations/aggregates/query:
    post:
      tags:
      - Analytics
      summary: Query for evaluation aggregates
      description: ''
      operationId: postAnalyticsEvaluationsAggregatesQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/EvaluationAggregationQuery'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/EvaluationAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:evaluationAggregate:view
      x-purecloud-method-name: postAnalyticsEvaluationsAggregatesQuery
  /api/v2/analytics/evaluations/aggregates/jobs:
    post:
      tags:
      - Analytics
      summary: Query for evaluation aggregates asynchronously
      description: ''
      operationId: postAnalyticsEvaluationsAggregatesJobs
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/EvaluationAsyncAggregationQuery'
      responses:
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:evaluationAggregate:view
      x-purecloud-method-name: postAnalyticsEvaluationsAggregatesJobs
  /api/v2/analytics/evaluations/aggregates/jobs/{jobId}:
    get:
      tags:
      - Analytics
      summary: Get status for async query for evaluation aggregates
      description: ''
      operationId: getAnalyticsEvaluationsAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:evaluationAggregate:view
      x-purecloud-method-name: getAnalyticsEvaluationsAggregatesJob
    delete:
      tags:
      - Analytics
      summary: Delete/cancel an async request for evaluation aggregates
      description: ''
      operationId: deleteAnalyticsEvaluationsAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '204':
          description: Deleted
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:evaluationAggregate:view
      x-purecloud-method-name: deleteAnalyticsEvaluationsAggregatesJob
  /api/v2/analytics/evaluations/aggregates/jobs/{jobId}/results:
    get:
      tags:
      - Analytics
      summary: Fetch a page of results for an async aggregates query
      description: ''
      operationId: getAnalyticsEvaluationsAggregatesJobResults
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      - name: cursor
        in: query
        description: Cursor token to retrieve next page
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/EvaluationAsyncAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:evaluationAggregate:view
      x-purecloud-method-name: getAnalyticsEvaluationsAggregatesJobResults
  /api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}:
    get:
      tags:
      - Analytics
      summary: Get status for async query for flow execution aggregates
      description: ''
      operationId: getAnalyticsFlowexecutionsAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:flowExecutionAggregate:view
      x-purecloud-method-name: getAnalyticsFlowexecutionsAggregatesJob
    delete:
      tags:
      - Analytics
      summary: Delete/cancel an async request for flow execution aggregates
      description: ''
      operationId: deleteAnalyticsFlowexecutionsAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '204':
          description: Deleted
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:flowExecutionAggregate:view
      x-purecloud-method-name: deleteAnalyticsFlowexecutionsAggregatesJob
  /api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}/results:
    get:
      tags:
      - Analytics
      summary: Fetch a page of results for an async aggregates query
      description: ''
      operationId: getAnalyticsFlowexecutionsAggregatesJobResults
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      - name: cursor
        in: query
        description: Cursor token to retrieve next page
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/FlowExecutionAsyncAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:flowExecutionAggregate:view
      x-purecloud-method-name: getAnalyticsFlowexecutionsAggregatesJobResults
  /api/v2/analytics/flowexecutions/aggregates/query:
    post:
      tags:
      - Analytics
      summary: Query for flow execution aggregates
      description: ''
      operationId: postAnalyticsFlowexecutionsAggregatesQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/FlowExecutionAggregationQuery'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/FlowExecutionAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:flowExecutionAggregate:view
      x-purecloud-method-name: postAnalyticsFlowexecutionsAggregatesQuery
  /api/v2/analytics/flowexecutions/aggregates/jobs:
    post:
      tags:
      - Analytics
      summary: Query for flow execution aggregates asynchronously
      description: ''
      operationId: postAnalyticsFlowexecutionsAggregatesJobs
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/FlowExecutionAsyncAggregationQuery'
      responses:
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:flowExecutionAggregate:view
      x-purecloud-method-name: postAnalyticsFlowexecutionsAggregatesJobs
  /api/v2/analytics/flows/aggregates/jobs:
    post:
      tags:
      - Analytics
      summary: Query for flow aggregates asynchronously
      description: ''
      operationId: postAnalyticsFlowsAggregatesJobs
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/FlowAsyncAggregationQuery'
      responses:
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:flowAggregate:view
      x-purecloud-method-name: postAnalyticsFlowsAggregatesJobs
  /api/v2/analytics/flows/aggregates/jobs/{jobId}:
    get:
      tags:
      - Analytics
      summary: Get status for async query for Flow aggregates
      description: ''
      operationId: getAnalyticsFlowsAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:flowAggregate:view
      x-purecloud-method-name: getAnalyticsFlowsAggregatesJob
    delete:
      tags:
      - Analytics
      summary: Delete/cancel an async request for flow aggregates
      description: ''
      operationId: deleteAnalyticsFlowsAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '204':
          description: Deleted
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:flowAggregate:view
      x-purecloud-method-name: deleteAnalyticsFlowsAggregatesJob
  /api/v2/analytics/flows/aggregates/jobs/{jobId}/results:
    get:
      tags:
      - Analytics
      summary: Fetch a page of results for an async aggregates query
      description: ''
      operationId: getAnalyticsFlowsAggregatesJobResults
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      - name: cursor
        in: query
        description: Cursor token to retrieve next page
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/FlowAsyncAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:flowAggregate:view
      x-purecloud-method-name: getAnalyticsFlowsAggregatesJobResults
  /api/v2/analytics/flows/observations/query:
    post:
      tags:
      - Analytics
      summary: Query for flow observations
      description: ''
      operationId: postAnalyticsFlowsObservationsQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/FlowObservationQuery'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/FlowObservationQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:flowObservation:view
      x-purecloud-method-name: postAnalyticsFlowsObservationsQuery
  /api/v2/analytics/flows/activity/query:
    post:
      tags:
      - Analytics
      summary: Query for flow activity observations
      description: ''
      operationId: postAnalyticsFlowsActivityQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/FlowActivityQuery'
      - name: pageSize
        in: query
        description: The desired page size
        required: false
        type: integer
        format: int32
      - name: pageNumber
        in: query
        description: The desired page number
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/FlowActivityResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:flowObservation:view
      x-purecloud-method-name: postAnalyticsFlowsActivityQuery
  /api/v2/analytics/flows/aggregates/query:
    post:
      tags:
      - Analytics
      summary: Query for flow aggregates
      description: ''
      operationId: postAnalyticsFlowsAggregatesQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/FlowAggregationQuery'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/FlowAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to query for flow aggregates.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:flowAggregate:view
      x-purecloud-method-name: postAnalyticsFlowsAggregatesQuery
  /api/v2/analytics/journeys/aggregates/query:
    post:
      tags:
      - Analytics
      summary: Query for journey aggregates
      description: ''
      operationId: postAnalyticsJourneysAggregatesQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/JourneyAggregationQuery'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:journeyAggregate:view
      x-purecloud-method-name: postAnalyticsJourneysAggregatesQuery
  /api/v2/analytics/journeys/aggregates/jobs:
    post:
      tags:
      - Analytics
      summary: Query for journey aggregates asynchronously
      description: ''
      operationId: postAnalyticsJourneysAggregatesJobs
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/JourneyAsyncAggregationQuery'
      responses:
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:journeyAggregate:view
      x-purecloud-method-name: postAnalyticsJourneysAggregatesJobs
  /api/v2/analytics/journeys/aggregates/jobs/{jobId}:
    get:
      tags:
      - Analytics
      summary: Get status for async query for journey aggregates
      description: ''
      operationId: getAnalyticsJourneysAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:journeyAggregate:view
      x-purecloud-method-name: getAnalyticsJourneysAggregatesJob
    delete:
      tags:
      - Analytics
      summary: Delete/cancel an async request for journey aggregates
      description: ''
      operationId: deleteAnalyticsJourneysAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '204':
          description: Deleted
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:journeyAggregate:view
      x-purecloud-method-name: deleteAnalyticsJourneysAggregatesJob
  /api/v2/analytics/journeys/aggregates/jobs/{jobId}/results:
    get:
      tags:
      - Analytics
      summary: Fetch a page of results for an async aggregates query
      description: ''
      operationId: getAnalyticsJourneysAggregatesJobResults
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      - name: cursor
        in: query
        description: Cursor token to retrieve next page
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyAsyncAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:journeyAggregate:view
      x-purecloud-method-name: getAnalyticsJourneysAggregatesJobResults
  /api/v2/analytics/knowledge/aggregates/query:
    post:
      tags:
      - Analytics
      summary: Query for knowledge aggregates
      description: ''
      operationId: postAnalyticsKnowledgeAggregatesQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/KnowledgeAggregationQuery'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/KnowledgeAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:knowledgeAggregate:view
      x-purecloud-method-name: postAnalyticsKnowledgeAggregatesQuery
  /api/v2/analytics/knowledge/aggregates/jobs:
    post:
      tags:
      - Analytics
      summary: Query for knowledge aggregates asynchronously
      description: ''
      operationId: postAnalyticsKnowledgeAggregatesJobs
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/KnowledgeAsyncAggregationQuery'
      responses:
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:knowledgeAggregate:view
      x-purecloud-method-name: postAnalyticsKnowledgeAggregatesJobs
  /api/v2/analytics/knowledge/aggregates/jobs/{jobId}:
    get:
      tags:
      - Analytics
      summary: Get status for async query for knowledge aggregates
      description: ''
      operationId: getAnalyticsKnowledgeAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:knowledgeAggregate:view
      x-purecloud-method-name: getAnalyticsKnowledgeAggregatesJob
    delete:
      tags:
      - Analytics
      summary: Delete/cancel an async request for knowledge aggregates
      description: ''
      operationId: deleteAnalyticsKnowledgeAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '204':
          description: Deleted
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:knowledgeAggregate:view
      x-purecloud-method-name: deleteAnalyticsKnowledgeAggregatesJob
  /api/v2/analytics/knowledge/aggregates/jobs/{jobId}/results:
    get:
      tags:
      - Analytics
      summary: Fetch a page of results for an async aggregates query
      description: ''
      operationId: getAnalyticsKnowledgeAggregatesJobResults
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      - name: cursor
        in: query
        description: Cursor token to retrieve next page
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/KnowledgeAsyncAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:knowledgeAggregate:view
      x-purecloud-method-name: getAnalyticsKnowledgeAggregatesJobResults
  /api/v2/analytics/queues/observations/query:
    post:
      tags:
      - Analytics
      summary: Query for queue observations
      description: ''
      operationId: postAnalyticsQueuesObservationsQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/QueueObservationQuery'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/QueueObservationQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: This user is not permitted to query for queue.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
            general.internal.server.error: An internal server error has occurred.
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:queueObservation:view
      x-purecloud-method-name: postAnalyticsQueuesObservationsQuery
  /api/v2/analytics/ratelimits/aggregates/query:
    post:
      tags:
      - Analytics
      summary: Query for limits rate limit aggregates. Data populated when limits reach 90% of the maximum. Not a source of truth for limits hit but a best effort estimate.
      description: The 'max' property can be used to determine estimated rate limit value hit. See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
      operationId: postAnalyticsRatelimitsAggregatesQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/RateLimitAggregationQuery'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/RateLimitAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:rateLimitAggregate:view
      x-purecloud-method-name: postAnalyticsRatelimitsAggregatesQuery
  /api/v2/analytics/resolutions/aggregates/query:
    post:
      tags:
      - Analytics
      summary: Query for resolution aggregates
      description: ''
      operationId: postAnalyticsResolutionsAggregatesQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/ResolutionAggregationQuery'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ResolutionAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:resolutionAggregate:view
      x-purecloud-method-name: postAnalyticsResolutionsAggregatesQuery
  /api/v2/analytics/resolutions/aggregates/jobs:
    post:
      tags:
      - Analytics
      summary: Query for resolution aggregates asynchronously
      description: ''
      operationId: postAnalyticsResolutionsAggregatesJobs
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/ResolutionAsyncAggregationQuery'
      responses:
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:resolutionAggregate:view
      x-purecloud-method-name: postAnalyticsResolutionsAggregatesJobs
  /api/v2/analytics/resolutions/aggregates/jobs/{jobId}:
    get:
      tags:
      - Analytics
      summary: Get status for async query for resolution aggregates
      description: ''
      operationId: getAnalyticsResolutionsAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:resolutionAggregate:view
      x-purecloud-method-name: getAnalyticsResolutionsAggregatesJob
    delete:
      tags:
      - Analytics
      summary: Delete/cancel an async request for resolution aggregates
      description: ''
      operationId: deleteAnalyticsResolutionsAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '204':
          description: Deleted
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:resolutionAggregate:view
      x-purecloud-method-name: deleteAnalyticsResolutionsAggregatesJob
  /api/v2/analytics/resolutions/aggregates/jobs/{jobId}/results:
    get:
      tags:
      - Analytics
      summary: Fetch a page of results for an async aggregates query
      description: ''
      operationId: getAnalyticsResolutionsAggregatesJobResults
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      - name: cursor
        in: query
        description: Cursor token to retrieve next page
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ResolutionAsyncAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:resolutionAggregate:view
      x-purecloud-method-name: getAnalyticsResolutionsAggregatesJobResults
  /api/v2/analytics/routing/activity/query:
    post:
      tags:
      - Analytics
      summary: Query for user activity observations
      description: ''
      operationId: postAnalyticsRoutingActivityQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/RoutingActivityQuery'
      - name: pageSize
        in: query
        description: The desired page size
        required: false
        type: integer
        format: int32
      - name: pageNumber
        in: query
        description: The desired page number
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/RoutingActivityResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:queueObservation:view
      x-purecloud-method-name: postAnalyticsRoutingActivityQuery
  /api/v2/analytics/summaries/aggregates/query:
    post:
      tags:
      - Analytics
      summary: Query for summary aggregates
      description: ''
      operationId: postAnalyticsSummariesAggregatesQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/SummaryAggregationQuery'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/SummaryAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:summaryAggregate:view
      x-purecloud-method-name: postAnalyticsSummariesAggregatesQuery
  /api/v2/analytics/summaries/aggregates/jobs:
    post:
      tags:
      - Analytics
      summary: Query for summary aggregates asynchronously
      description: ''
      operationId: postAnalyticsSummariesAggregatesJobs
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/SummaryAsyncAggregationQuery'
      responses:
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:summaryAggregate:view
      x-purecloud-method-name: postAnalyticsSummariesAggregatesJobs
  /api/v2/analytics/summaries/aggregates/jobs/{jobId}:
    get:
      tags:
      - Analytics
      summary: Get status for async query for summary aggregates
      description: ''
      operationId: getAnalyticsSummariesAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:summaryAggregate:view
      x-purecloud-method-name: getAnalyticsSummariesAggregatesJob
    delete:
      tags:
      - Analytics
      summary: Delete/cancel an async request for summary aggregates
      description: ''
      operationId: deleteAnalyticsSummariesAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '204':
          description: Deleted
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:summaryAggregate:view
      x-purecloud-method-name: deleteAnalyticsSummariesAggregatesJob
  /api/v2/analytics/summaries/aggregates/jobs/{jobId}/results:
    get:
      tags:
      - Analytics
      summary: Fetch a page of results for an async aggregates query
      description: ''
      operationId: getAnalyticsSummariesAggregatesJobResults
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      - name: cursor
        in: query
        description: Cursor token to retrieve next page
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/SummaryAsyncAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:summaryAggregate:view
      x-purecloud-method-name: getAnalyticsSummariesAggregatesJobResults
  /api/v2/analytics/surveys/aggregates/query:
    post:
      tags:
      - Analytics
      summary: Query for survey aggregates
      description: ''
      operationId: postAnalyticsSurveysAggregatesQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/SurveyAggregationQuery'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/SurveyAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:surveyAggregate:view
      x-purecloud-method-name: postAnalyticsSurveysAggregatesQuery
  /api/v2/analytics/surveys/aggregates/jobs:
    post:
      tags:
      - Analytics
      summary: Query for survey aggregates asynchronously
      description: ''
      operationId: postAnalyticsSurveysAggregatesJobs
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/SurveyAsyncAggregationQuery'
      responses:
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:surveyAggregate:view
      x-purecloud-method-name: postAnalyticsSurveysAggregatesJobs
  /api/v2/analytics/surveys/aggregates/jobs/{jobId}:
    get:
      tags:
      - Analytics
      summary: Get status for async query for survey aggregates
      description: ''
      operationId: getAnalyticsSurveysAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:surveyAggregate:view
      x-purecloud-method-name: getAnalyticsSurveysAggregatesJob
    delete:
      tags:
      - Analytics
      summary: Delete/cancel an async request for survey aggregates
      description: ''
      operationId: deleteAnalyticsSurveysAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '204':
          description: Deleted
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:surveyAggregate:view
      x-purecloud-method-name: deleteAnalyticsSurveysAggregatesJob
  /api/v2/analytics/surveys/aggregates/jobs/{jobId}/results:
    get:
      tags:
      - Analytics
      summary: Fetch a page of results for an async aggregates query
      description: ''
      operationId: getAnalyticsSurveysAggregatesJobResults
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      - name: cursor
        in: query
        description: Cursor token to retrieve next page
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/SurveyAsyncAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:surveyAggregate:view
      x-purecloud-method-name: getAnalyticsSurveysAggregatesJobResults
  /api/v2/analytics/taskmanagement/aggregates/query:
    post:
      tags:
      - Analytics
      summary: Query for task management aggregates
      description: ''
      operationId: postAnalyticsTaskmanagementAggregatesQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/TaskManagementAggregationQuery'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/TaskManagementAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:taskManagementAggregate:view
      x-purecloud-method-name: postAnalyticsTaskmanagementAggregatesQuery
  /api/v2/analytics/taskmanagement/aggregates/jobs/{jobId}:
    get:
      tags:
      - Analytics
      summary: Get status for async query for task management aggregates
      description: ''
      operationId: getAnalyticsTaskmanagementAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:taskManagementAggregate:view
      x-purecloud-method-name: getAnalyticsTaskmanagementAggregatesJob
    delete:
      tags:
      - Analytics
      summary: Delete/cancel an async request for task management aggregates
      description: ''
      operationId: deleteAnalyticsTaskmanagementAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '204':
          description: Deleted
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:taskManagementAggregate:view
      x-purecloud-method-name: deleteAnalyticsTaskmanagementAggregatesJob
  /api/v2/analytics/taskmanagement/aggregates/jobs/{jobId}/results:
    get:
      tags:
      - Analytics
      summary: Fetch a page of results for an async task management query
      description: ''
      operationId: getAnalyticsTaskmanagementAggregatesJobResults
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      - name: cursor
        in: query
        description: Cursor token to retrieve next page
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/TaskManagementAsyncAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:taskManagementAggregate:view
      x-purecloud-method-name: getAnalyticsTaskmanagementAggregatesJobResults
  /api/v2/analytics/taskmanagement/metrics/query:
    post:
      tags:
      - Analytics
      summary: Query for task management observations
      description: ''
      operationId: postAnalyticsTaskmanagementMetricsQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/TaskManagementObservationQuery'
      - name: after
        in: query
        description: The cursor that points to the end of the set of entities that has been returned. Used for pagination.
        required: false
        type: string
      - name: pageSize
        in: query
        description: Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200.
        required: false
        type: integer
        maximum: 200
        minimum: 1
        format: int32
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/TaskManagementObservationQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - analytics:taskManagementObservation:view
      x-purecloud-method-name: postAnalyticsTaskmanagementMetricsQuery
  /api/v2/analytics/taskmanagement/aggregates/jobs:
    post:
      tags:
      - Analytics
      summary: Query for task management aggregates asynchronously
      description: ''
      operationId: postAnalyticsTaskmanagementAggregatesJobs
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/TaskManagementAsyncAggregationQuery'
      responses:
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:taskManagementAggregate:view
      x-purecloud-method-name: postAnalyticsTaskmanagementAggregatesJobs
  /api/v2/analytics/teams/activity/query:
    post:
      tags:
      - Analytics
      summary: Query for team activity observations
      description: ''
      operationId: postAnalyticsTeamsActivityQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/TeamActivityQuery'
      - name: pageSize
        in: query
        description: The desired page size
        required: false
        type: integer
        format: int32
      - name: pageNumber
        in: query
        description: The desired page number
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/TeamActivityResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:teamObservation:view
      x-purecloud-method-name: postAnalyticsTeamsActivityQuery
  /api/v2/analytics/transcripts/aggregates/query:
    post:
      tags:
      - Analytics
      summary: Query for transcript aggregates
      description: ''
      operationId: postAnalyticsTranscriptsAggregatesQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/TranscriptAggregationQuery'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/TranscriptAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:speechAndTextAnalyticsAggregates:view
      x-purecloud-method-name: postAnalyticsTranscriptsAggregatesQuery
  /api/v2/analytics/transcripts/aggregates/jobs:
    post:
      tags:
      - Analytics
      summary: Query for transcript aggregates asynchronously
      description: ''
      operationId: postAnalyticsTranscriptsAggregatesJobs
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/TranscriptAsyncAggregationQuery'
      responses:
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:speechAndTextAnalyticsAggregates:view
      x-purecloud-method-name: postAnalyticsTranscriptsAggregatesJobs
  /api/v2/analytics/transcripts/aggregates/jobs/{jobId}:
    get:
      tags:
      - Analytics
      summary: Get status for async query for transcript aggregates
      description: ''
      operationId: getAnalyticsTranscriptsAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:speechAndTextAnalyticsAggregates:view
      x-purecloud-method-name: getAnalyticsTranscriptsAggregatesJob
    delete:
      tags:
      - Analytics
      summary: Delete/cancel an async request for transcript aggregates
      description: ''
      operationId: deleteAnalyticsTranscriptsAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '204':
          description: Deleted
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:speechAndTextAnalyticsAggregates:view
      x-purecloud-method-name: deleteAnalyticsTranscriptsAggregatesJob
  /api/v2/analytics/transcripts/aggregates/jobs/{jobId}/results:
    get:
      tags:
      - Analytics
      summary: Fetch a page of results for an async aggregates query
      description: ''
      operationId: getAnalyticsTranscriptsAggregatesJobResults
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      - name: cursor
        in: query
        description: Cursor token to retrieve next page
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/TranscriptAsyncAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:speechAndTextAnalyticsAggregates:view
      x-purecloud-method-name: getAnalyticsTranscriptsAggregatesJobResults
  /api/v2/analytics/users/aggregates/query:
    post:
      tags:
      - Analytics
      summary: Query for user aggregates
      description: ''
      operationId: postAnalyticsUsersAggregatesQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/UserAggregationQuery'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/UserAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:userAggregate:view
      x-purecloud-method-name: postAnalyticsUsersAggregatesQuery
  /api/v2/analytics/users/aggregates/jobs:
    post:
      tags:
      - Analytics
      summary: Query for user aggregates asynchronously
      description: ''
      operationId: postAnalyticsUsersAggregatesJobs
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/UserAsyncAggregationQuery'
      responses:
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:userAggregate:view
      x-purecloud-method-name: postAnalyticsUsersAggregatesJobs
  /api/v2/analytics/users/aggregates/jobs/{jobId}:
    get:
      tags:
      - Analytics
      summary: Get status for async query for user aggregates
      description: ''
      operationId: getAnalyticsUsersAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:userAggregate:view
      x-purecloud-method-name: getAnalyticsUsersAggregatesJob
    delete:
      tags:
      - Analytics
      summary: Delete/cancel an async request for user aggregates
      description: ''
      operationId: deleteAnalyticsUsersAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '204':
          description: Deleted
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:userAggregate:view
      x-purecloud-method-name: deleteAnalyticsUsersAggregatesJob
  /api/v2/analytics/users/aggregates/jobs/{jobId}/results:
    get:
      tags:
      - Analytics
      summary: Fetch a page of results for an async aggregates query
      description: ''
      operationId: getAnalyticsUsersAggregatesJobResults
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      - name: cursor
        in: query
        description: Cursor token to retrieve next page
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/UserAsyncAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:userAggregate:view
      x-purecloud-method-name: getAnalyticsUsersAggregatesJobResults
  /api/v2/analytics/users/details/query:
    post:
      tags:
      - Analytics
      summary: Query for user details
      description: ''
      operationId: postAnalyticsUsersDetailsQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/UserDetailsQuery'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AnalyticsUserDetailsQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:userDetail:view
      x-purecloud-method-name: postAnalyticsUsersDetailsQuery
  /api/v2/analytics/users/observations/query:
    post:
      tags:
      - Analytics
      summary: Query for user observations
      description: ''
      operationId: postAnalyticsUsersObservationsQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/UserObservationQuery'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/UserObservationQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:userObservation:view
      x-purecloud-method-name: postAnalyticsUsersObservationsQuery
  /api/v2/analytics/users/activity/query:
    post:
      tags:
      - Analytics
      summary: Query for user activity observations
      description: ''
      operationId: postAnalyticsUsersActivityQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/UserActivityQuery'
      - name: pageSize
        in: query
        description: The desired page size
        required: false
        type: integer
        format: int32
      - name: pageNumber
        in: query
        description: The desired page number
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/UserActivityResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:userObservation:view
      x-purecloud-method-name: postAnalyticsUsersActivityQuery
  /api/v2/analytics/users/details/jobs:
    post:
      tags:
      - Analytics
      summary: Query for user details asynchronously
      description: ''
      operationId: postAnalyticsUsersDetailsJobs
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/AsyncUserDetailsQuery'
      responses:
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:userDetail:view
      x-purecloud-method-name: postAnalyticsUsersDetailsJobs
  /api/v2/analytics/users/details/jobs/{jobId}:
    get:
      tags:
      - Analytics
      summary: Get status for async query for user details
      description: ''
      operationId: getAnalyticsUsersDetailsJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:userDetail:view
      x-purecloud-method-name: getAnalyticsUsersDetailsJob
    delete:
      tags:
      - Analytics
      summary: Delete/cancel an async request
      description: ''
      operationId: deleteAnalyticsUsersDetailsJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '204':
          description: Deleted
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:userDetail:view
      x-purecloud-method-name: deleteAnalyticsUsersDetailsJob
  /api/v2/analytics/users/details/jobs/{jobId}/results:
    get:
      tags:
      - Analytics
      summary: Fetch a page of results for an async query
      description: ''
      operationId: getAnalyticsUsersDetailsJobResults
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      - name: cursor
        in: query
        description: Indicates where to resume query results (not required for first page)
        required: false
        type: string
      - name: pageSize
        in: query
        description: The desired maximum number of results
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AnalyticsUserDetailsAsyncQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:userDetail:view
      x-purecloud-method-name: getAnalyticsUsersDetailsJobResults
  /api/v2/analytics/users/details/jobs/availability:
    get:
      tags:
      - Analytics
      summary: Lookup the datalake availability date and time
      description: ''
      operationId: getAnalyticsUsersDetailsJobsAvailability
      produces:
      - application/json
      parameters: []
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/DataAvailabilityResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:userDetail:view
      x-purecloud-method-name: getAnalyticsUsersDetailsJobsAvailability
  /api/v2/analytics/botflows/{botFlowId}/divisions/reportingturns:
    get:
      tags:
      - Analytics
      summary: Get Reporting Turns (division aware).
      description: 'Returns the reporting turns for the specified flow, filtered by the clients divisions and grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. It is expected that the client will URL encode the request URI once only. For pagination, clients should keep sending requests using the value of ''nextUri'' in the response, until it''s no longer present, only then have all items have been returned. The ''nextUri'' value in the response is already URL encoded (so it doesn''t need to be encoded again). Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.'
      operationId: getAnalyticsBotflowDivisionsReportingturns
      produces:
      - application/json
      parameters:
      - name: botFlowId
        in: path
        description: ID of the bot flow.
        required: true
        type: string
      - name: after
        in: query
        description: The cursor that points to the ID of the last item in the list of entities that has been returned.
        required: false
        type: string
      - name: pageSize
        in: query
        description: Max number of entities to return. Maximum of 250
        required: false
        type: string
        default: '50'
      - name: interval
        in: query
        description: 'Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: ''2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07''. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
        required: false
        type: string
        format: interval
        x-example: 2023-07-17T08:15:44.586Z/2023-07-26T09:22:33.111Z
      - name: actionId
        in: query
        description: Optional action ID to get the reporting turns associated to a particular flow action
        required: false
        type: string
      - name: sessionId
        in: query
        description: Optional session ID to get the reporting turns for a particular session. Specifying a session ID alongside an action ID or a language or any ask action results is not allowed.
        required: false
        type: string
      - name: language
        in: query
        description: Optional language code to get the reporting turns for a particular language
        required: false
        type: string
        x-example: en-us
      - name: askActionResults
        in: query
        description: Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
        required: false
        type: string
        enum:
        - AgentRequestedByUser
        - ConfirmationRequired
        - DisambiguationRequired
        - Error
        - ExpressionError
        - NoInputCollection
        - NoInputConfirmation
        - NoInputDisambiguation
        - NoMatchCollection
        - NoMatchConfirmation
        - NoMatchDisambiguation
        - SuccessCollection
        - SkippedCollection
        - SuccessConfirmationNo
        - SuccessConfirmationYes
        - SuccessDisambiguation
        - SuccessDisambiguationNone
        - GuardrailsViolation
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ReportingTurnsResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:botFlowDivisionAwareReportingTurn:view
      x-purecloud-method-name: getAnalyticsBotflowDivisionsReportingturns
  /api/v2/analytics/botflows/{botFlowId}/reportingturns:
    get:
      tags:
      - Analytics
      summary: Get Reporting Turns.
      description: 'Deprecated: Please use GET /analytics/botflows/{botFlowId}/divisions/reportingturns instead. Returns the reporting turns grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. It is expected that the client will URL encode the request URI once only. For pagination, clients should keep sending requests using the value of ''nextUri'' in the response, until it''s no longer present, only then have all items have been returned. The ''nextUri'' value in the response is already URL encoded (so it doesn''t need to be encoded again). Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.'
      operationId: getAnalyticsBotflowReportingturns
      produces:
      - application/json
      parameters:
      - name: botFlowId
        in: path
        description: ID of the bot flow.
        required: true
        type: string
      - name: after
        in: query
        description: The cursor that points to the ID of the last item in the list of entities that has been returned.
        required: false
        type: string
      - name: pageSize
        in: query
        description: Max number of entities to return. Maximum of 250
        required: false
        type: string
        default: '50'
      - name: interval
        in: query
        description: 'Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: ''2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07''. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
        required: false
        type: string
        format: interval
        x-example: 2023-07-17T08:15:44.586Z/2023-07-26T09:22:33.111Z
      - name: actionId
        in: query
        description: Optional action ID to get the reporting turns associated to a particular flow action
        required: false
        type: string
      - name: sessionId
        in: query
        description: Optional session ID to get the reporting turns for a particular session. Specifying a session ID alongside an action ID or a language or any ask action results is not allowed.
        required: false
        type: string
      - name: language
        in: query
        description: Optional language code to get the reporting turns for a particular language
        required: false
        type: string
        x-example: en-us
      - name: askActionResults
        in: query
        description: Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
        required: false
        type: string
        enum:
        - AgentRequestedByUser
        - ConfirmationRequired
        - DisambiguationRequired
        - Error
        - ExpressionError
        - NoInputCollection
        - NoInputConfirmation
        - NoInputDisambiguation
        - NoMatchCollection
        - NoMatchConfirmation
        - NoMatchDisambiguation
        - SuccessCollection
        - SkippedCollection
        - SuccessConfirmationNo
        - SuccessConfirmationYes
        - SuccessDisambiguation
        - SuccessDisambiguationNone
        - GuardrailsViolation
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ReportingTurnsResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      deprecated: true
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:botFlowReportingTurn:view
      x-purecloud-method-name: getAnalyticsBotflowReportingturns
  /api/v2/analytics/botflows/{botFlowId}/sessions:
    get:
      tags:
      - Analytics
      summary: Get Bot Flow Sessions.
      description: 'Returns the bot flow sessions in reverse chronological order from the date they were created. It is expected that the client will URL encode the request URI once only. For pagination, clients should keep sending requests using the value of ''nextUri'' in the response, until it''s no longer present, only then have all items have been returned. The ''nextUri'' value in the response is already URL encoded (so it doesn''t need to be encoded again). Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.'
      operationId: getAnalyticsBotflowSessions
      produces:
      - application/json
      parameters:
      - name: botFlowId
        in: path
        description: ID of the bot flow.
        required: true
        type: string
      - name: after
        in: query
        description: The cursor that points to the ID of the last item in the list of entities that has been returned.
        required: false
        type: string
      - name: pageSize
        in: query
        description: Max number of entities to return. Maximum of 250
        required: false
        type: string
        default: '50'
      - name: interval
        in: query
        description: 'Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: ''2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07''. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
        required: false
        type: string
        format: interval
        x-example: 2023-07-17T08:15:44.586Z/2023-07-26T09:22:33.111Z
      - name: botResultCategories
        in: query
        description: Optional case-insensitive comma separated list of Bot Result Categories to filter sessions by.
        required: false
        type: string
        enum:
        - Unknown
        - UserExit
        - BotExit
        - Error
        - RecognitionFailure
        - UserDisconnect
        - BotDisconnect
        - SessionExpired
        - Transfer
      - name: endLanguage
        in: query
        description: Optional case-insensitive language code to filter sessions by the language the sessions ended in.
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/SessionsResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:botFlowSession:view
      x-purecloud-method-name: getAnalyticsBotflowSessions
  /api/v2/analytics/dataretention/settings:
    get:
      tags:
      - Analytics
      summary: Get analytics data retention setting
      description: ''
      operationId: getAnalyticsDataretentionSettings
      produces:
      - application/json
      parameters: []
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AnalyticsDataRetentionResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:dataRetention:view
      x-purecloud-method-name: getAnalyticsDataretentionSettings
    put:
      tags:
      - Analytics
      summary: Update analytics data retention setting
      description: ''
      operationId: putAnalyticsDataretentionSettings
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: retentionDays
        required: true
        schema:
          $ref: '#/definitions/UpdateAnalyticsDataRetentionRequest'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AnalyticsDataRetentionResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
            analytics.data.retention.update.conflict: The provided analytics data retention setting conflicts with existing policies/recordings in the org. Ensure that no recording policies retain recordings for longer than the provided retentionDays, and no recordings have delete dates further away from their creation dates than the provided retentionDays.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:dataRetention:edit
      x-purecloud-method-name: putAnalyticsDataretentionSettings
  /api/v2/analytics/reporting/settings:
    get:
      tags:
      - Analytics
      summary: Get AnalyticsReportingSettings for an organization
      description: ''
      operationId: getAnalyticsReportingSettings
      produces:
      - application/json
      parameters: []
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AnalyticsReportingSettings'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-purecloud-method-name: getAnalyticsReportingSettings
    patch:
      tags:
      - Analytics
      summary: Patch AnalyticsReportingSettings values for an organization
      description: ''
      operationId: patchAnalyticsReportingSettings
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: AnalyticsReportingSettingsRequest
        required: true
        schema:
          $ref: '#/definitions/AnalyticsReportingSettings'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AnalyticsReportingSettings'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            general.bad.request: Unable to update AnalyticsReportingSettings due to invalid request.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            general.resource.not.found: AnalyticsReportingSettings for organization not found.
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:reportingSettings:edit
      x-purecloud-method-name: patchAnalyticsReportingSettings
  /api/v2/analytics/reporting/settings/dashboards/bulk/remove:
    post:
      tags:
      - Analytics
      summary: Bulk soft delete dashboard configurations
      description: ''
      operationId: postAnalyticsReportingSettingsDashboardsBulkRemove
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/DashboardConfigurationBulkRequest'
      responses:
        '204':
          description: Dashboard Configurations were deleted successfully.
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - analytics:dashboardConfigurations:edit
      x-purecloud-method-name: postAnalyticsReportingSettingsDashboardsBulkRemove
  /api/v2/analytics/reporting/settings/dashboards/query:
    get:
      tags:
      - Analytics
      summary: Get list of dashboard configurations
      description: ''
      operationId: getAnalyticsReportingSettingsDashboardsQuery
      produces:
      - application/json
      parameters:
      - name: name
        in: query
        description: name of the dashboard
        required: false
        type: string
      - name: dashboardType
        in: query
        description: List dashboard of given type
        required: true
        type: string
        enum:
        - All
        - Public
        - Private
        - Shared
        - Favorites
      - name: dashboardState
        in: query
        description: List dashboard of given state
        required: false
        type: string
        default: Active
        enum:
        - Active
        - Deleted
      - name: dashboardAccessFilter
        in: query
        description: Filter dashboard based on the owner of dashboard
        required: true
        type: string
        enum:
        - OwnedByMe
        - OwnedByAnyone
        - NotOwnedByMe
      - name: sortBy
        in: query
        required: false
        type: string
        default: desc
      - name: pageNumber
        in: query
        required: false
        type: integer
        default: 1
        format: int32
      - name: pageSize
        in: query
        required: false
        type: integer
        default: 9
        format: int32
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/DashboardConfigurationListing'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - analytics:dashboardConfigurations:view
      x-purecloud-method-name: getAnalyticsReportingSettingsDashboardsQuery
    post:
      tags:
      - Analytics
      summary: Query dashboard configurations
      description: ''
      operationId: postAnalyticsReportingSettingsDashboardsQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/DashboardConfigurationQueryRequest'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/DashboardConfigurationListing'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - analytics:dashboardConfigurations:view
      x-purecloud-method-name: postAnalyticsReportingSettingsDashboardsQuery
  /api/v2/analytics/reporting/dashboards/users/{userId}:
    get:
      tags:
      - Analytics
      summary: Get dashboards summary for a user
      description: ''
      operationId: getAnalyticsReportingDashboardsUser
      produces:
      - application/json
      parameters:
      - name: userId
        in: path
        description: User ID
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/DashboardUser'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - analytics:dashboardConfigurations:view
      x-purecloud-method-name: getAnalyticsReportingDashboardsUser
  /api/v2/analytics/reporting/dashboards/users/bulk/remove:
    post:
      tags:
      - Analytics
      summary: Bulk soft delete dashboards owned by other user(s)
      description: ''
      operationId: postAnalyticsReportingDashboardsUsersBulkRemove
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: List of userIds
        required: true
        schema:
          type: array
          items:
            type: string
      responses:
        '204':
          description: Dashboards were deleted successfully.
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:dashboardConfigurations:deleteActive
        - analytics:dashboardConfigurations:deleteInactive
      x-purecloud-method-name: postAnalyticsReportingDashboardsUsersBulkRemove
  /api/v2/analytics/reporting/dashboards/users:
    get:
      tags:
      - Analytics
      summary: Get dashboards summary for users in a org
      description: ''
      operationId: getAnalyticsReportingDashboardsUsers
      produces:
      - application/json
      parameters:
      - name: sortBy
        in: query
        required: false
        type: string
        default: asc
      - name: pageNumber
        in: query
        required: false
        type: integer
        default: 1
        format: int32
      - name: pageSize
        in: query
        required: false
        type: integer
        default: 25
        format: int32
      - name: id
        in: query
        description: A list of user IDs to fetch by bulk
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: state
        in: query
        description: Only list users of this state
        required: false
        type: string
        enum:
        - active
        - inactive
      - name: deletedOnly
        in: query
        description: Only list users with deleted dashboards
        required: false
        type: boolean
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/DashboardUserListing'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - analytics:dashboardConfigurations:view
      x-purecloud-method-name: getAnalyticsReportingDashboardsUsers
  /api/v2/analytics/reporting/settings/users/{userId}/dashboards:
    get:
      tags:
      - Analytics
      summary: Get list of dashboards for an user
      description: ''
      operationId: getAnalyticsReportingSettingsUserDashboards
      produces:
      - application/json
      parameters:
      - name: userId
        in: path
        description: User ID
        required: true
        type: string
      - name: sortBy
        in: query
        required: false
        type: string
        default: asc
      - name: pageNumber
        in: query
        required: false
        type: integer
        default: 1
        format: int32
      - name: pageSize
        in: query
        required: false
        type: integer
        default: 50
        format: int32
      - name: publicOnly
        in: query
        description: If true, retrieve only public dashboards
        required: false
        type: boolean
      - name: favoriteOnly
        in: query
        description: If true, retrieve only favorite dashboards
        required: false
        type: boolean
      - name: deletedOnly
        in: query
        description: If true, retrieve only deleted dashboards that are still recoverable
        required: false
        type: boolean
      - name: name
        in: query
        description: retrieve dashboards that match with given name
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/DashboardConfigurationListing'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - analytics:dashboardConfigurations:viewPrivate
      x-purecloud-method-name: getAnalyticsReportingSettingsUserDashboards
  /api/v2/analytics/reporting/exports/metadata:
    get:
      tags:
      - Analytics
      summary: Get all export metadata
      description: ''
      operationId: getAnalyticsReportingExportsMetadata
      produces:
      - application/json
      parameters: []
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ReportingExportMetadataJobListing'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - analytics:dataExport:view
      x-purecloud-method-name: getAnalyticsReportingExportsMetadata
  /api/v2/analytics/reporting/exports:
    get:
      tags:
      - Analytics
      summary: Get all view export requests for a user
      description: ''
      operationId: getAnalyticsReportingExports
      produces:
      - application/json
      parameters:
      - name: pageNumber
        in: query
        description: Page number
        required: false
        type: integer
        default: 1
        format: int32
      - name: pageSize
        in: query
        description: Page size
        required: false
        type: integer
        default: 25
        format: int32
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ReportingExportJobListing'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - analytics:dataExport:view
      x-purecloud-method-name: getAnalyticsReportingExports
    post:
      tags:
      - Analytics
      summary: Generate a view export request
      description: This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead
      operationId: postAnalyticsReportingExports
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: ReportingExportJobRequest
        required: true
        schema:
          $ref: '#/definitions/ReportingExportJobRequest'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ReportingExportJobResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            general.bad.request: Bad user request
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            forbidden: Forbidden to generate a view export request.
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - analytics
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - analytics:dataExport:add
      x-purecloud-method-name: postAnalyticsReportingExports
definitions:
  FlowActivityEntityData:
    type: object
    required:
    - activityDate
    properties:
      activityDate:
        type: string
        format: date-time
        description: 'The time at which the activity was observed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      metric:
        type: string
        description: Activity metric
        enum:
        - oFlow
      activeRouting:
        type: string
        description: Active routing method
        enum:
        - Bullseye
        - Conditional
        - Direct
        - Last
        - Manual
        - Predictive
        - Preferred
        - Standard
        - Vip
      addressFrom:
        type: string
        description: The address that initiated an action
      addressTo:
        type: string
        description: The address receiving an action
      ani:
        type: string
        description: Automatic Number Identification (caller's number)
      conversationId:
        type: string
        description: Unique identifier for the conversation
      convertedFrom:
        type: string
        description: Session media type that was converted from in case of a media type conversion
      convertedTo:
        type: string
        description: Session media type that was converted to in case of a media type conversion
      direction:
        type: string
        description: The direction of the communication
        enum:
        - inbound
        - outbound
      dnis:
        type: string
        description: Dialed number identification service (number dialed by the calling party)
      flowId:
        type: string
        description: The unique identifier of this flow
      flowType:
        type: string
        description: The type of this flow
        enum:
        - BOT
        - COMMONMODULE
        - DIGITALBOT
        - EMAILSEND
        - INBOUNDCALL
        - INBOUNDCHAT
        - INBOUNDEMAIL
        - INBOUNDSHORTMESSAGE
        - INQUEUECALL
        - INQUEUEEMAIL
        - INQUEUESHORTMESSAGE
        - OUTBOUNDCALL
        - SECURECALL
        - SPEECH
        - SURVEYINVITE
        - VOICE
        - VOICEMAIL
        - VOICESURVEY
        - WORKFLOW
        - WORKITEM
      mediaType:
        type: string
        description: The session media type
        enum:
        - callback
        - chat
        - cobrowse
        - email
        - internalmessage
        - message
        - screenmonitoring
        - screenshare
        - unknown
        - video
        - voice
      participantName:
        type: string
        description: A human readable name identifying the participant
      queueId:
        type: string
        description: Queue identifier
      requestedLanguageId:
        type: string
        description: Unique identifier for the language requested for an interaction
      requestedRoutingSkillIds:
        type: array
        description: Unique identifier(s) for skill(s) requested for an interaction
        items:
          type: string
      requestedRoutings:
        type: array
        description: Routing type(s) for requested/attempted routing methods.
        items:
          type: string
          enum:
          - Bullseye
          - Conditional
          - Direct
          - Last
          - Manual
          - Predictive
          - Preferred
          - Standard
          - Vip
      routingPriority:
        type: integer
        format: int64
        description: Routing priority for the current interaction
      sessionId:
        type: string
        description: The unique identifier of this session
      teamId:
        type: string
        description: The team ID the user is a member of
      usedRouting:
        type: string
        description: Complete routing method
        enum:
        - Bullseye
        - Conditional
        - Direct
        - Last
        - Manual
        - Predictive
        - Preferred
        - Standard
        - Vip
      userId:
        type: string
        description: Unique identifier for the user
      scoredAgents:
        type: array
        description: Scored agents
        items:
          $ref: '#/definitions/FlowActivityScoredAgent'
  UserObservationQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - userId
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension predicates
        $ref: '#/definitions/NumericRange'
  UserActivityQueryMetric:
    type: object
    required:
    - metric
    properties:
      metric:
        type: string
        description: The requested metric
        enum:
        - oActiveQueues
        - oMemberQueues
      details:
        type: boolean
        description: Flag for including observation details for this metric in the response
  Cursors:
    type: object
    properties:
      before:
        type: string
      after:
        type: string
  UserAggregateDataContainer:
    type: object
    properties:
      group:
        type: object
        description: A mapping from dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        items:
          $ref: '#/definitions/StatisticalResponse'
  TaskManagementAsyncAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/TaskManagementAggregateDataContainer'
      cursor:
        type: string
        description: Cursor token to retrieve next page
  SurveyAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/SurveyAggregateDataContainer'
  AnalyticsDataRetentionResponse:
    type: object
    properties:
      retentionDays:
        type: integer
        format: int32
        description: Analytics data retention period in days for the organization.
      dateCreated:
        type: string
        format: date-time
        description: 'Date and time when the analytics data retention was set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      dateModified:
        type: string
        format: date-time
        description: 'Date and time when the analytics data retention was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  UserDetailQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/UserDetailQueryPredicate'
  ConversationAggregationView:
    type: object
    required:
    - function
    - name
    - target
    properties:
      target:
        type: string
        description: Target metric name
        enum:
        - nBlindTransferred
        - nBotInteractions
        - nCallbackAttempts
        - nCallbackOverSla
        - nCallbackScheduled
        - nCfcOffered
        - nCobrowseSessions
        - nConnected
        - nConsult
        - nConsultTransferred
        - nConversations
        - nError
        - nOffered
        - nOutbound
        - nOutboundAbandoned
        - nOutboundAttempted
        - nOutboundConnected
        - nOverSla
        - nStateTransitionError
        - nTakeover
        - nTransferred
        - oAudioMessageCount
        - oCallbackServiceLevel
        - oExternalAudioMessageCount
        - oExternalMediaCount
        - oMediaCount
        - oMessageCount
        - oMessageSegmentCount
        - oMessageTurn
        - oServiceLevel
        - oServiceTarget
        - oSkillExpressionApplications
        - tAbandon
        - tAcd
        - tActiveCallback
        - tActiveCallbackComplete
        - tAcw
        - tAgentResponseTime
        - tAgentVideoConnected
        - tAlert
        - tAnswered
        - tAverageAgentResponseTime
        - tAverageCustomerResponseTime
        - tBarging
        - tCallbackAbandon
        - tCallbackConnect
        - tCallbackNotReached
        - tCallbackVirtualWait
        - tCfcAbandon
        - tCfcAcd
        - tCfcAnswered
        - tCfcFlowOut
        - tCoaching
        - tCoachingComplete
        - tConnected
        - tContacting
        - tDialing
        - tFirstConnect
        - tFirstDial
        - tFirstEngagement
        - tFirstResponse
        - tFlowOut
        - tHandle
        - tHeld
        - tHeldComplete
        - tIvr
        - tMonitoring
        - tMonitoringComplete
        - tNotResponding
        - tPark
        - tParkComplete
        - tScreenMonitoring
        - tShortAbandon
        - tSnippetRecord
        - tTalk
        - tTalkComplete
        - tTransmitting
        - tUserResponseTime
        - tVoicemail
        - tWait
      name:
        type: string
        description: A unique name for this view. Must be distinct from other views and built-in metric names.
      function:
        type: string
        description: Type of view you wish to create
        enum:
        - rangeBound
      range:
        description: Range of numbers for slicing up data
        $ref: '#/definitions/AggregationRange'
  StatisticalSummary:
    type: object
    properties:
      max:
        type: number
      min:
        type: number
      count:
        type: integer
        format: int64
      countNegative:
        type: integer
        format: int64
      countPositive:
        type: integer
        format: int64
      sum:
        type: number
      current:
        type: number
      ratio:
        type: number
      numerator:
        type: number
      denominator:
        type: number
      target:
        type: number
      p95:
        type: integer
        format: int64
      p99:
        type: integer
        format: int64
      calculatedMetricValue:
        type: integer
        format: int64
  ResolutionAsyncAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/ResolutionAggregateDataContainer'
      cursor:
        type: string
        description: Cursor token to retrieve next page
  AnalyticsSurvey:
    type: object
    properties:
      eventTime:
        type: string
        format: date-time
        description: 'Specifies when an event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      queueId:
        type: string
        description: The ID of the associated queue
      surveyCompletedDate:
        type: string
        format: date-time
        description: Completion datetime of the survey in ISO 8601 format
      surveyFormContextId:
        type: string
        description: Unique identifier for the survey form, regardless of version
      surveyFormId:
        type: string
        description: ID of the survey form used
      surveyFormName:
        type: string
        description: Name of the survey form used
      surveyId:
        type: string
        description: ID of the survey
      surveyPartialResponse:
        type: boolean
        description: Whether the survey was completed with any required questions unanswered.
      surveyPromoterScore:
        type: integer
        format: int32
        description: Score of the survey used with NPS
      surveyStatus:
        type: string
        description: The status of the survey
      surveyType:
        type: string
        description: The type of the survey
        enum:
        - Web
        - Voice
      userId:
        type: string
        description: ID of the agent the survey was performed against
      oSurveyTotalScore:
        type: integer
        format: int64
  SurveyAggregateQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/SurveyAggregateQueryPredicate'
  UserActivityData:
    type: object
    properties:
      group:
        type: object
        description: A mapping from grouping dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        description: Data for metrics
        items:
          $ref: '#/definitions/UserActivityMetricValue'
      truncated:
        type: boolean
        description: Flag for a truncated list of entities. If truncated, the first half of the list of entities will contain the oldest entities and the second half the newest entities.
      entities:
        type: array
        description: Details for active entities
        items:
          $ref: '#/definitions/UserActivityEntityData'
  ConversationActivityData:
    type: object
    properties:
      group:
        type: object
        description: A mapping from grouping dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        description: Data for metrics
        items:
          $ref: '#/definitions/ConversationActivityMetricValue'
      truncated:
        type: boolean
        description: Flag for a truncated list of entities. If truncated, the first half of the list of entities will contain the oldest entities and the second half the newest entities.
      entities:
        type: array
        description: Details for active entities
        items:
          $ref: '#/definitions/ConversationActivityEntityData'
  AnalyticsConversationWithoutAttributes:
    type: object
    properties:
      accessAttributes:
        type: array
        description: Set of attributes that limit which users can access the conversation
        items:
          type: string
      associatedConversationId:
        type: string
        description: ID of the conversation the initiator is signaling this new conversation is associated with
      conferenceStart:
        type: string
        format: date-time
        description: 'The start time of a conference call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      consultationConversationIds:
        type: array
        description: Set of conversationIds the initiator has signaled this conversation is associated with
        items:
          type: string
      conversationEnd:
        type: string
        format: date-time
        description: 'The end time of a conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      conversationId:
        type: string
        description: Unique identifier for the conversation
      conversationInitiator:
        type: string
        description: Indicates the participant purpose of the participant initiating a message conversation
        enum:
        - acd
        - agent
        - api
        - botflow
        - campaign
        - customer
        - dialer
        - external
        - fax
        - group
        - inbound
        - ivr
        - manual
        - outbound
        - station
        - user
        - voicemail
        - voicesurveyflow
        - workflow
      conversationStart:
        type: string
        format: date-time
        description: 'The start time of a conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      customerParticipation:
        type: boolean
        description: Indicates a messaging conversation in which the customer participated by sending at least one message
      divisionIds:
        type: array
        description: Identifier(s) of division(s) associated with a conversation
        items:
          type: string
      externalTag:
        type: string
        description: External tag for the conversation
      inactivityTimeout:
        type: string
        format: date-time
        description: 'The time in the future, after which this conversation would be considered inactive. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      knowledgeBaseIds:
        type: array
        description: The unique identifier(s) of the knowledge base(s) used
        items:
          type: string
      mediaStatsMinConversationMos:
        type: number
        format: double
        description: The lowest estimated average MOS among all the audio streams belonging to this conversation
      mediaStatsMinConversationRFactor:
        type: number
        format: double
        description: The lowest R-factor value among all of the audio streams belonging to this conversation
      originatingDirection:
        type: string
        description: The original direction of the conversation
        enum:
        - inbound
        - outbound
      originatingSocialMediaPublic:
        type: boolean
        description: Indicates that the conversation originated from a public message on social media
      selfServed:
        type: boolean
        description: Indicates whether all flow sessions were self serviced
      evaluations:
        type: array
        description: Evaluations associated with this conversation
        items:
          $ref: '#/definitions/AnalyticsEvaluation'
      surveys:
        type: array
        description: Surveys associated with this conversation
        items:
          $ref: '#/definitions/AnalyticsSurvey'
      resolutions:
        type: array
        description: Resolutions associated with this conversation
        items:
          $ref: '#/definitions/AnalyticsResolution'
      participants:
        type: array
        description: Participants in the conversation
        items:
          $ref: '#/definitions/AnalyticsParticipantWithoutAttributes'
  AgentCopilotAggregateDataContainer:
    type: object
    properties:
      group:
        type: object
        description: A mapping from dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        items:
          $ref: '#/definitions/StatisticalResponse'
  UserActivityEntityData:
    type: object
    required:
    - activityDate
    properties:
      activityDate:
        type: string
        format: date-time
        description: 'The time at which the activity was observed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      organizationPresenceId:
        type: string
        description: Organization presence identifier
      presenceDate:
        type: string
        format: date-time
        description: 'Date of the latest presence change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      queueId:
        type: string
        description: Queue identifier
      queueMembershipStatus:
        type: string
        description: Queue membership status (e.g. active or inactive)
      routingStatus:
        type: string
        description: Agent routing status
      routingStatusDate:
        type: string
        format: date-time
        description: 'Date of the latest routing status change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      systemPresence:
        type: string
        description: System presence
      teamId:
        type: string
        description: The team ID the user is a member of
      userId:
        type: string
        description: Unique identifier for the user
  UserAggregateQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/UserAggregateQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/UserAggregateQueryPredicate'
  AggregationResult:
    type: object
    properties:
      type:
        type: string
        enum:
        - termFrequency
        - numericRange
      dimension:
        type: string
        description: For termFrequency aggregations
      metric:
        type: string
        description: For numericRange aggregations
      count:
        type: integer
        format: int64
      results:
        type: array
        items:
          $ref: '#/definitions/AggregationResultEntry'
  ConversationAggregateDataContainer:
    type: object
    properties:
      group:
        type: object
        description: A mapping from dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        items:
          $ref: '#/definitions/StatisticalResponse'
  AgentCopilotAggregateQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/AgentCopilotAggregateQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/AgentCopilotAggregateQueryPredicate'
  ActionAggregateQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/ActionAggregateQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/ActionAggregateQueryPredicate'
  ConversationDetailQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/ConversationDetailQueryPredicate'
  FlowObservationDataContainer:
    type: object
    properties:
      group:
        type: object
        description: A mapping from dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        items:
          $ref: '#/definitions/ObservationMetricData'
  AnalyticsScoredAgent:
    type: object
    properties:
      agentScore:
        type: integer
        format: int32
        description: Assigned agent score for this conversation (0 - 100, higher being better)
      scoredAgentId:
        type: string
        description: Unique identifier for the agent that was scored for this conversation
  RateLimitAggregateDataContainer:
    type: object
    properties:
      group:
        type: object
        description: A mapping from dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        items:
          $ref: '#/definitions/StatisticalResponse'
  TaskManagementObservationResult:
    type: object
    properties:
      group:
        description: The group dimensions and their values for this result. Represents the combination of groupBy dimensions that define this result set.
        $ref: '#/definitions/TaskManagementObservationGroupResult'
      data:
        type: array
        description: The metric data for this group. Contains the actual observation values for each requested metric.
        items:
          $ref: '#/definitions/TaskManagementObservationDataContainer'
  FlowAggregateDataContainer:
    type: object
    properties:
      group:
        type: object
        description: A mapping from dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        items:
          $ref: '#/definitions/StatisticalResponse'
  ObservationMetricData:
    type: object
    properties:
      metric:
        type: string
      qualifier:
        type: string
      stats:
        $ref: '#/definitions/StatisticalSummary'
      truncated:
        type: boolean
        description: Flag for a truncated list of observations. If truncated, the first half of the list of observations will contain the oldest observations and the second half the newest observations.
      observations:
        type: array
        description: List of observations sorted by timestamp in ascending order. This list may be truncated.
        items:
          $ref: '#/definitions/ObservationValue'
  DashboardUserListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/DashboardUser'
      pageSize:
        type: integer
        format: int32
      pageNumber:
        type: integer
        format: int32
      total:
        type: integer
        format: int64
      firstUri:
        type: string
        format: uri
      nextUri:
        type: string
        format: uri
      previousUri:
        type: string
        format: uri
      lastUri:
        type: string
        format: uri
      selfUri:
        type: string
        format: uri
      pageCount:
        type: integer
        format: int32
  TaskManagementObservationDataContainer:
    type: object
    properties:
      metric:
        type: string
        description: The metric for this data point
        enum:
        - oWorkitemsUnassigned
        - oWorkitemsAssigned
        - oWorkitemsConnected
        - oWorkitemsParked
        - oWorkitemsHeld
        - oWorkitemsAcdStarted
        - oWorkitemsDeclined
        - oWorkitemsIdle
        - oWorkitemsDisconnected
        - oWorkitemsAcdExpired
        - oWorkitemsDue
        - oWorkitemsOverDue
        - oWorkitemOldestUnassigned
        - oWorkitemOldestAssigned
      stats:
        description: The observed statistics for this metric
        $ref: '#/definitions/TaskManagementObservationMetricStats'
      qualifier:
        type: string
        description: Qualifier for duration based metrics.
        enum:
        - Hours24
        - Hours72
  TaskManagementObservationQueryFilter:
    type: object
    required:
    - predicates
    properties:
      predicates:
        type: array
        description: List of predicates that define the filter conditions. Each predicate specifies a dimension and value to filter by. A single queueId predicate is always required.
        items:
          $ref: '#/definitions/TaskManagementObservationPredicate'
        maxItems: 2147483647
        minItems: 1
  ConversationActivityScoredAgent:
    type: object
    properties:
      agentScore:
        type: integer
        format: int32
        description: Assigned agent score for this conversation (0 - 100, higher being better)
      scoredAgentId:
        type: string
        description: Unique identifier for the agent that was scored for this conversation
  DashboardConfigurationBulkRequest:
    type: object
    required:
    - dashboardConfigurationIds
    properties:
      dashboardConfigurationIds:
        type: array
        description: The user supplied dashboard configuration ids
        items:
          type: string
  SegmentDetailQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - addressFrom
        - addressTo
        - agentAssistantId
        - agentOwned
        - ani
        - authenticated
        - bargedParticipantId
        - callbackNumber
        - callbackScheduledTime
        - canonicalExternalContactId
        - cleared
        - coachedParticipantId
        - conference
        - deliveryPushed
        - deliveryStatus
        - destinationAddress
        - destinationConversationId
        - detectedSpeechEnd
        - detectedSpeechStart
        - direction
        - disconnectType
        - dnis
        - edgeId
        - engagementSource
        - errorCode
        - exitReason
        - extendedDeliveryStatus
        - externalContactId
        - externalOrganizationId
        - flaggedReason
        - flowId
        - flowName
        - flowOutType
        - flowOutcome
        - flowOutcomeId
        - flowOutcomeValue
        - flowVersion
        - groupId
        - journeyActionId
        - journeyActionMapId
        - journeyCustomerId
        - journeyCustomerIdType
        - journeyCustomerSessionId
        - mediaCount
        - mediaType
        - messageType
        - monitoredParticipantId
        - outboundCampaignId
        - outboundContactId
        - outboundContactListId
        - participantName
        - protocolCallId
        - provider
        - purpose
        - queueId
        - recording
        - remote
        - remoteNameDisplayable
        - requestedLanguageId
        - requestedRouting
        - requestedRoutingSkillId
        - scoredAgentId
        - screenMonitoredUserId
        - screenRecording
        - scriptId
        - segmentEnd
        - segmentType
        - sessionDnis
        - sipResponseCode
        - skillExpressionId
        - snippetRecording
        - subject
        - teamId
        - transferTargetAddress
        - transferTargetName
        - transferType
        - usedRouting
        - userId
        - wrapUpCode
        - wrapUpNote
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      propertyType:
        type: string
        description: Left hand side for property predicates
        enum:
        - bool
        - integer
        - real
        - date
        - string
        - uuid
      property:
        type: string
        description: Left hand side for property predicates
      metric:
        type: string
        description: Left hand side for metric predicates
        enum:
        - tSegmentDuration
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension, metric, or property predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension, metric, or property predicates
        $ref: '#/definitions/NumericRange'
  AnalyticsAgentStateQueryResponse:
    type: object
    properties:
      entities:
        type: array
        description: List of agents
        items:
          $ref: '#/definitions/AnalyticsAgentStateAgentResponse'
  EvaluationAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
        x-genesys-entity-type:
          value: INTERVAL
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - assigneeApplicable
          - assigneeId
          - calibrationId
          - contextId
          - conversationId
          - divisionId
          - evaluationContextId
          - evaluationId
          - evaluatorId
          - formId
          - mediaType
          - queueId
          - released
          - rescored
          - systemSubmitted
          - teamId
          - userId
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/EvaluationAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nEvaluations
          - nEvaluationsDeleted
          - nEvaluationsRescored
          - oTotalCriticalScore
          - oTotalScore
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/EvaluationAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - conversationStart
        - evaluationCreatedDate
        - evaluationReleaseDate
        - eventTime
  AgentStateSessionQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: Describes a <dimension> = <value> filter used to perform matching
        items:
          $ref: '#/definitions/AgentStateSessionQueryPredicate'
  KnowledgeAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/KnowledgeAggregateDataContainer'
  ConversationActivityQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/ConversationActivityQueryPredicate'
  AnalyticsConversationAsyncQueryResponse:
    type: object
    properties:
      conversations:
        type: array
        items:
          $ref: '#/definitions/AnalyticsConversation'
      cursor:
        type: string
        description: Optional cursor to indicate where to resume the results
      dataAvailabilityDate:
        type: string
        format: date-time
        description: 'Data available up to at least this datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  UpdateAnalyticsDataRetentionRequest:
    type: object
    required:
    - retentionDays
    properties:
      retentionDays:
        type: integer
        format: int32
        description: Analytics data retention period in days to set for the organization.
  UserObservationQuery:
    type: object
    required:
    - filter
    - metrics
    properties:
      filter:
        description: Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/UserObservationQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - oActiveQueues
          - oMemberQueues
      detailMetrics:
        type: array
        description: Metrics for which to include additional detailed observations
        items:
          type: string
          enum:
          - oActiveQueues
          - oMemberQueues
  AnalyticsConversation:
    type: object
    properties:
      accessAttributes:
        type: array
        description: Set of attributes that limit which users can access the conversation
        items:
          type: string
      associatedConversationId:
        type: string
        description: ID of the conversation the initiator is signaling this new conversation is associated with
      conferenceStart:
        type: string
        format: date-time
        description: 'The start time of a conference call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      consultationConversationIds:
        type: array
        description: Set of conversationIds the initiator has signaled this conversation is associated with
        items:
          type: string
      conversationEnd:
        type: string
        format: date-time
        description: 'The end time of a conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      conversationId:
        type: string
        description: Unique identifier for the conversation
      conversationInitiator:
        type: string
        description: Indicates the participant purpose of the participant initiating a message conversation
        enum:
        - acd
        - agent
        - api
        - botflow
        - campaign
        - customer
        - dialer
        - external
        - fax
        - group
        - inbound
        - ivr
        - manual
        - outbound
        - station
        - user
        - voicemail
        - voicesurveyflow
        - workflow
      conversationStart:
        type: string
        format: date-time
        description: 'The start time of a conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      customerParticipation:
        type: boolean
        description: Indicates a messaging conversation in which the customer participated by sending at least one message
      divisionIds:
        type: array
        description: Identifier(s) of division(s) associated with a conversation
        items:
          type: string
      externalTag:
        type: string
        description: External tag for the conversation
      inactivityTimeout:
        type: string
        format: date-time
        description: 'The time in the future, after which this conversation would be considered inactive. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      knowledgeBaseIds:
        type: array
        description: The unique identifier(s) of the knowledge base(s) used
        items:
          type: string
      mediaStatsMinConversationMos:
        type: number
        format: double
        description: The lowest estimated average MOS among all the audio streams belonging to this conversation
      mediaStatsMinConversationRFactor:
        type: number
        format: double
        description: The lowest R-factor value among all of the audio streams belonging to this conversation
      originatingDirection:
        type: string
        description: The original direction of the conversation
        enum:
        - inbound
        - outbound
      originatingSocialMediaPublic:
        type: boolean
        description: Indicates that the conversation originated from a public message on social media
      selfServed:
        type: boolean
        description: Indicates whether all flow sessions were self serviced
      evaluations:
        type: array
        description: Evaluations associated with this conversation
        items:
          $ref: '#/definitions/AnalyticsEvaluation'
      surveys:
        type: array
        description: Surveys associated with this conversation
        items:
          $ref: '#/definitions/AnalyticsSurvey'
      resolutions:
        type: array
        description: Resolutions associated with this conversation
        items:
          $ref: '#/definitions/AnalyticsResolution'
      participants:
        type: array
        description: Participants in the conversation
        items:
          $ref: '#/definitions/AnalyticsParticipant'
  QueueObservationQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/QueueObservationQueryPredicate'
  PropertyIndexRequest:
    type: object
    required:
    - properties
    - sessionId
    - targetDate
    properties:
      sessionId:
        type: string
        description: Attach properties to a segment in the indicated session
      targetDate:
        type: string
        format: date-time
        description: 'Attach properties to a segment covering a specific point in time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      properties:
        type: array
        description: The list of properties to index
        items:
          $ref: '#/definitions/AnalyticsProperty'
  SummaryAsyncAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - conversationId
          - copied
          - editedField
          - errorType
          - language
          - mediaType
          - messageType
          - presented
          - queueId
          - summaryGenerated
          - summaryId
          - summaryRating
          - triggerSourceId
          - triggerSourceOutcome
          - triggerSourceType
          - userId
          - wrapUpCodeRating
          - wrapUpCodeSuggestionSelected
          - wrapupCodesGenerated
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/SummaryAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nConversationSummaries
          - nConversationSummaryEngagements
          - tConversationSummary
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/SummaryAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
      queryType:
        type: string
        description: Query type to use. Use groupBy for all matching results, and topN/bottomN for N results ordered by the sortMetric. Default is groupBy.
        enum:
        - bottomN
        - groupBy
        - topN
      sortMetric:
        description: Required when requesting multiple metrics. Only applicable for topN/bottomN query type.
        $ref: '#/definitions/SummaryAggregationSort'
      limit:
        type: integer
        format: int32
        description: How many results you want in an ordered list. Only applicable for topN/bottomN query type.
      pageSize:
        type: integer
        format: int32
        description: The number of results per page
  SurveyAggregationView:
    type: object
    required:
    - function
    - name
    - target
    properties:
      target:
        type: string
        description: Target metric name
        enum:
        - nSurveyErrors
        - nSurveyFullResponses
        - nSurveyNpsDetractors
        - nSurveyNpsPromoters
        - nSurveyNpsResponses
        - nSurveyPartialResponses
        - nSurveyQuestionGroupResponses
        - nSurveyQuestionResponses
        - nSurveyResponses
        - nSurveysAbandoned
        - nSurveysDeleted
        - nSurveysExpired
        - nSurveysSent
        - nSurveysStarted
        - nVoiceSurveys
        - nWebSurveys
        - oSurveyQuestionGroupScore
        - oSurveyQuestionScore
        - oSurveyTotalScore
      name:
        type: string
        description: A unique name for this view. Must be distinct from other views and built-in metric names.
      function:
        type: string
        description: Type of view you wish to create
        enum:
        - rangeBound
      range:
        description: Range of numbers for slicing up data
        $ref: '#/definitions/AggregationRange'
  ConversationActivityQuery:
    type: object
    required:
    - groupBy
    - metrics
    properties:
      metrics:
        type: array
        description: List of requested metrics
        items:
          $ref: '#/definitions/ConversationActivityQueryMetric'
      groupBy:
        type: array
        description: Dimension(s) to group by
        uniqueItems: true
        items:
          type: string
          enum:
          - activeRouting
          - addressFrom
          - addressTo
          - agentScore
          - ani
          - conversationId
          - convertedFrom
          - convertedTo
          - direction
          - dnis
          - mediaType
          - participantName
          - queueId
          - requestedLanguageId
          - requestedRouting
          - requestedRoutingSkillId
          - routingPriority
          - scoredAgentId
          - sessionId
          - teamId
          - usedRouting
          - userId
      filter:
        description: Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/ConversationActivityQueryFilter'
      order:
        type: string
        description: Sort the result set in ascending/descending order. Default is ascending
        enum:
        - asc
        - desc
        - unordered
  TaskManagementQueryMetric:
    type: object
    required:
    - name
    properties:
      name:
        type: string
        description: The requested metric name
        enum:
        - oWorkitemsUnassigned
        - oWorkitemsAssigned
        - oWorkitemsConnected
        - oWorkitemsParked
        - oWorkitemsHeld
        - oWorkitemsAcdStarted
        - oWorkitemsDeclined
        - oWorkitemsIdle
        - oWorkitemsDisconnected
        - oWorkitemsAcdExpired
        - oWorkitemsDue
        - oWorkitemsOverDue
        - oWorkitemOldestUnassigned
        - oWorkitemOldestAssigned
      qualifier:
        type: string
        description: Qualifier for duration based metrics. Required when requesting oWorkitemsDue
        enum:
        - Hours24
        - Hours72
  ResolutionAggregationView:
    type: object
    required:
    - function
    - name
    - target
    properties:
      target:
        type: string
        description: Target metric name
        enum:
        - nNextContactAvoided
      name:
        type: string
        description: A unique name for this view. Must be distinct from other views and built-in metric names.
      function:
        type: string
        description: Type of view you wish to create
        enum:
        - rangeBound
      range:
        description: Range of numbers for slicing up data
        $ref: '#/definitions/AggregationRange'
  ConversationAggregationSort:
    type: object
    required:
    - function
    - name
    properties:
      name:
        type: string
        description: Name of the metric used for sorting values.
        enum:
        - nBlindTransferred
        - nBotInteractions
        - nCallbackAttempts
        - nCallbackOverSla
        - nCallbackScheduled
        - nCfcOffered
        - nCobrowseSessions
        - nConnected
        - nConsult
        - nConsultTransferred
        - nConversations
        - nError
        - nOffered
        - nOutbound
        - nOutboundAbandoned
        - nOutboundAttempted
        - nOutboundConnected
        - nOverSla
        - nStateTransitionError
        - nTakeover
        - nTransferred
        - oAudioMessageCount
        - oExternalAudioMessageCount
        - oExternalMediaCount
        - oMediaCount
        - oMessageCount
        - oMessageSegmentCount
        - oMessageTurn
        - oServiceTarget
        - oSkillExpressionApplications
        - tAbandon
        - tAcd
        - tActiveCallback
        - tActiveCallbackComplete
        - tAcw
        - tAgentResponseTime
        - tAgentVideoConnected
        - tAlert
        - tAnswered
        - tAverageAgentResponseTime
        - tAverageCustomerResponseTime
        - tBarging
        - tCallbackAbandon
        - tCallbackConnect
        - tCallbackNotReached
        - tCallbackVirtualWait
        - tCfcAbandon
        - tCfcAcd
        - tCfcAnswered
        - tCfcFlowOut
        - tCoaching
        - tCoachingComplete
        - tConnected
        - tContacting
        - tDialing
        - tFirstConnect
        - tFirstDial
        - tFirstEngagement
        - tFirstResponse
        - tFlowOut
        - tHandle
        - tHeld
        - tHeldComplete
        - tIvr
        - tMonitoring
        - tMonitoringComplete
        - tNotResponding
        - tPark
        - tParkComplete
        - tScreenMonitoring
        - tSnippetRecord
        - tTalk
        - tTalkComplete
        - tTransmitting
        - tUserResponseTime
        - tVoicemail
      function:
        type: string
        description: Aggregation function used for the sort metric.
        enum:
        - average
        - count
        - max
        - min
        - sum
  TaskManagementAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/TaskManagementAggregateDataContainer'
  JourneyAggregateQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/JourneyAggregateQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/JourneyAggregateQueryPredicate'
  RoutingActivityEntityData:
    type: object
    required:
    - activityDate
    properties:
      activityDate:
        type: string
        format: date-time
        description: 'The time at which the activity was observed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      organizationPresenceId:
        type: string
        description: Organization presence identifier
      presenceDate:
        type: string
        format: date-time
        description: 'Date of the latest presence change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      queueId:
        type: string
        description: Queue identifier
      queueMembershipStatus:
        type: string
        description: Queue membership status (e.g. active or inactive)
      routingStatus:
        type: string
        description: Agent routing status
      routingStatusDate:
        type: string
        format: date-time
        description: 'Date of the latest routing status change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      systemPresence:
        type: string
        description: System presence
      teamId:
        type: string
        description: The team ID the user is a member of
      userId:
        type: string
        description: Unique identifier for the user
  FlowExecutionAggregateQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/FlowExecutionAggregateQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/FlowExecutionAggregateQueryPredicate'
  ChartColumn:
    type: object
    properties:
      id:
        type: string
        description: Column Id
      columnType:
        type: string
        description: Type of column
        enum:
        - Default
        - Topic
        - SecondaryStatus
        - CustomCalculation
  TaskManagementObservationPredicate:
    type: object
    required:
    - dimension
    - value
    properties:
      dimension:
        type: string
        description: The dimension to filter on
        enum:
        - queueId
        - typeId
      value:
        type: string
        description: The value to filter by for the specified dimension
        pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}'
  ReportingTurnKnowledgeSearch:
    type: object
    properties:
      searchId:
        type: string
        description: The ID of this knowledge search.
      documents:
        type: array
        description: The list of search documents captured during this reporting turn.
        items:
          $ref: '#/definitions/ReportingTurnKnowledgeDocument'
      query:
        type: string
        description: The search query that was used to search the Knowledge Base documents for a matching question.
  TaskManagementObservationQuery:
    type: object
    required:
    - filter
    - groupBy
    - metrics
    properties:
      groupBy:
        type: array
        description: Dimension(s) to group by. Determines how the results will be grouped in the response.
        uniqueItems: true
        items:
          type: string
          enum:
          - queueId
          - typeId
          - assigneeId
          - statusCategory
        maxItems: 2147483647
        minItems: 1
      metrics:
        type: array
        description: List of metrics to be retrieved. Specifies which observational metrics should be included in the response.
        items:
          $ref: '#/definitions/TaskManagementQueryMetric'
        maxItems: 2147483647
        minItems: 1
      filter:
        description: Filter to return a subset of observations.
        $ref: '#/definitions/TaskManagementObservationQueryFilter'
      expands:
        type: array
        description: List of properties to expand. Additional details about the objects returned in the results will be included in the response if supplied.
        items:
          type: string
          enum:
          - type
          - assignee
  AgentStatePresenceCount:
    type: object
    properties:
      systemPresence:
        type: string
        description: System presence
        enum:
        - UNKNOWN
        - AVAILABLE
        - AWAY
        - BUSY
        - OFFLINE
        - IDLE
        - ON_QUEUE
        - MEAL
        - TRAINING
        - MEETING
        - BREAK
      organizationPresenceId:
        type: string
        description: The identifier for the organization presence
      count:
        type: integer
        format: int32
        description: Count of users with this system presence and organization presence
  TextBotUserAgent:
    type: object
    required:
    - name
    properties:
      name:
        type: string
        description: The name of the user agent.
        enum:
        - Phone
        - SMS
        - GenesysWebWidget
        - FacebookMessenger
        - WeChat
        - Whatsapp
        - AppleBusinessChat
        - Apple
        - Telegram
        - Slack
        - Signal
        - Line
        - Discord
        - TwitterDirectMessage
        - Open
        - Instagram
        - Other
        - Unknown
    description: Information about the caller executing a bot flow.
  AgentStateUserFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/AgentStateAgentQueryClause'
      predicates:
        type: array
        description: Describes a <dimension> = <value> filter used to perform matching
        items:
          $ref: '#/definitions/AgentStateAgentQueryPredicate'
  ConversationActivityEntityData:
    type: object
    required:
    - activityDate
    properties:
      activityDate:
        type: string
        format: date-time
        description: 'The time at which the activity was observed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      metric:
        type: string
        description: Activity metric
        enum:
        - oAlerting
        - oInteracting
        - oLongestInteracting
        - oLongestWaiting
        - oWaiting
      activeRouting:
        type: string
        description: Active routing method
        enum:
        - Bullseye
        - Conditional
        - Direct
        - Last
        - Manual
        - Predictive
        - Preferred
        - Standard
        - Vip
      addressFrom:
        type: string
        description: The address that initiated an action
      addressTo:
        type: string
        description: The address receiving an action
      ani:
        type: string
        description: Automatic Number Identification (caller's number)
      conversationId:
        type: string
        description: Unique identifier for the conversation
      convertedFrom:
        type: string
        description: Session media type that was converted from in case of a media type conversion
      convertedTo:
        type: string
        description: Session media type that was converted to in case of a media type conversion
      direction:
        type: string
        description: The direction of the communication
        enum:
        - inbound
        - outbound
      dnis:
        type: string
        description: Dialed number identification service (number dialed by the calling party)
      mediaType:
        type: string
        description: The session media type
        enum:
        - callback
        - chat
        - cobrowse
        - email
        - internalmessage
        - message
        - screenmonitoring
        - screenshare
        - unknown
        - video
        - voice
      participantName:
        type: string
        description: A human readable name identifying the participant
      queueId:
        type: string
        description: Queue identifier
      requestedLanguageId:
        type: string
        description: Unique identifier for the language requested for an interaction
      requestedRoutingSkillIds:
        type: array
        description: Unique identifier(s) for skill(s) requested for an interaction
        items:
          type: string
      requestedRoutings:
        type: array
        description: Routing type(s) for requested/attempted routing methods.
        items:
          type: string
          enum:
          - Bullseye
          - Conditional
          - Direct
          - Last
          - Manual
          - Predictive
          - Preferred
          - Standard
          - Vip
      routingPriority:
        type: integer
        format: int64
        description: Routing priority for the current interaction
      sessionId:
        type: string
        description: The unique identifier of this session
      teamId:
        type: string
        description: The team ID the user is a member of
      usedRouting:
        type: string
        description: Complete routing method
        enum:
        - Bullseye
        - Conditional
        - Direct
        - Last
        - Manual
        - Predictive
        - Preferred
        - Standard
        - Vip
      userId:
        type: string
        description: Unique identifier for the user
      scoredAgents:
        type: array
        description: Scored agents
        items:
          $ref: '#/definitions/ConversationActivityScoredAgent'
  FlowObservationQuery:
    type: object
    required:
    - filter
    - metrics
    properties:
      filter:
        description: Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/FlowObservationQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - oFlow
      detailMetrics:
        type: array
        description: Metrics for which to include additional detailed observations
        items:
          type: string
          enum:
          - oFlow
  ReportingTurnKnowledge:
    type: object
    properties:
      knowledgeBaseId:
        type: string
        description: The Knowledge Base ID that the captured knowledge data relates to.
      feedback:
        description: The knowledge feedback data that was captured during this reporting turn.
        $ref: '#/definitions/ReportingTurnKnowledgeFeedback'
      search:
        description: The knowledge search data that was captured during this reporting turn.
        $ref: '#/definitions/ReportingTurnKnowledgeSearch'
  ReportingExportJobRequest:
    type: object
    required:
    - exportFormat
    - filter
    - interval
    - locale
    - name
    - period
    - timeZone
    - viewType
    properties:
      name:
        type: string
        description: The user supplied name of the export request
      timeZone:
        type: string
        description: 'The requested timezone of the exported data. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      exportFormat:
        type: string
        description: The requested format of the exported data
        enum:
        - CSV
        - PDF
      interval:
        type: string
        format: interval
        description: 'The time period used to limit the the exported data. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
        x-genesys-entity-type:
          value: INTERVAL
      period:
        type: string
        description: 'The Period of the request in which to break down the intervals. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      viewType:
        type: string
        description: The type of view export job to be created
        enum:
        - QUEUE_PERFORMANCE_SUMMARY_VIEW
        - QUEUE_PERFORMANCE_DETAIL_VIEW
        - INTERACTION_SEARCH_VIEW
        - AGENT_PERFORMANCE_SUMMARY_VIEW
        - AGENT_PERFORMANCE_DETAIL_VIEW
        - AGENT_STATUS_SUMMARY_VIEW
        - AGENT_STATUS_DETAIL_VIEW
        - AGENT_EVALUATION_SUMMARY_VIEW
        - AGENT_EVALUATION_DETAIL_VIEW
        - AGENT_QUEUE_DETAIL_VIEW
        - AGENT_INTERACTION_DETAIL_VIEW
        - ABANDON_INSIGHTS_VIEW
        - SKILLS_PERFORMANCE_VIEW
        - SURVEY_FORM_PERFORMANCE_SUMMARY_VIEW
        - SURVEY_FORM_PERFORMANCE_DETAIL_VIEW
        - DNIS_PERFORMANCE_SUMMARY_VIEW
        - DNIS_PERFORMANCE_DETAIL_VIEW
        - WRAP_UP_PERFORMANCE_SUMMARY_VIEW
        - AGENT_WRAP_UP_PERFORMANCE_DETAIL_VIEW
        - QUEUE_ACTIVITY_SUMMARY_VIEW
        - QUEUE_ACTIVITY_DETAIL_VIEW
        - AGENT_QUEUE_ACTIVITY_SUMMARY_VIEW
        - QUEUE_AGENT_DETAIL_VIEW
        - QUEUE_INTERACTION_DETAIL_VIEW
        - AGENT_SCHEDULE_DETAIL_VIEW
        - IVR_PERFORMANCE_SUMMARY_VIEW
        - IVR_PERFORMANCE_DETAIL_VIEW
        - ANSWER_INSIGHTS_VIEW
        - HANDLE_INSIGHTS_VIEW
        - TALK_INSIGHTS_VIEW
        - HOLD_INSIGHTS_VIEW
        - ACW_INSIGHTS_VIEW
        - WAIT_INSIGHTS_VIEW
        - AGENT_WRAP_UP_PERFORMANCE_INTERVAL_DETAIL_VIEW
        - FLOW_OUTCOME_SUMMARY_VIEW
        - FLOW_OUTCOME_PERFORMANCE_DETAIL_VIEW
        - FLOW_OUTCOME_PERFORMANCE_INTERVAL_DETAIL_VIEW
        - FLOW_DESTINATION_SUMMARY_VIEW
        - FLOW_DESTINATION_DETAIL_VIEW
        - API_USAGE_VIEW
        - SCHEDULED_CALLBACKS_VIEW
        - CONTENT_SEARCH_VIEW
        - LANDING_PAGE
        - DASHBOARD_SUMMARY
        - DASHBOARD_DETAIL
        - DASHBOARD_USERS
        - DASHBOARD_USERS_DETAIL
        - JOURNEY_ACTION_MAP_SUMMARY_VIEW
        - JOURNEY_OUTCOME_SUMMARY_VIEW
        - JOURNEY_SEGMENT_SUMMARY_VIEW
        - AGENT_DEVELOPMENT_DETAIL_VIEW
        - AGENT_DEVELOPMENT_DETAIL_ME_VIEW
        - AGENT_DEVELOPMENT_SUMMARY_VIEW
        - AGENT_PERFORMANCE_ME_VIEW
        - AGENT_STATUS_ME_VIEW
        - AGENT_EVALUATION_ME_VIEW
        - AGENT_SCORECARD_VIEW
        - AGENT_SCORECARD_ME_VIEW
        - AGENT_GAMIFICATION_LEADERSHIP_VIEW
        - AGENT_SCHEDULE_ME_VIEW
        - BOT_PERFORMANCE_SUMMARY_VIEW
        - BOT_PERFORMANCE_DETAIL_VIEW
        - SCHEDULED_EXPORTS_VIEW
        - TOPIC_TREND_SUMMARY_VIEW
        - TOPIC_TREND_DETAIL_VIEW
        - ACTION_MAP_BLOCKED_CONSTRAINTS_DETAIL_VIEW
        - ACTION_MAP_BLOCKED_CONSTRAINTS_INTERVAL_DETAIL_VIEW
        - FLOW_MILESTONE_PERFORMANCE_DETAIL_VIEW
        - FLOW_MILESTONE_PERFORMANCE_INTERVAL_DETAIL_VIEW
        - AGENT_TOPIC_SUMMARY_VIEW
        - AGENT_TOPIC_DETAIL_VIEW
        - QUEUE_TOPIC_SUMMARY_VIEW
        - QUEUE_TOPIC_DETAIL_VIEW
        - FLOW_TOPIC_SUMMARY_VIEW
        - FLOW_TOPIC_DETAIL_VIEW
        - AGENT_INTERACTIONS_ME_VIEW
        - ALERT_RULES_VIEW
        - CONFIGURE_ALERT_RULE_VIEW
        - PREDICTIVE_ROUTING_VIEW
        - PREDICTIVE_ROUTING_QUEUE_OVERVIEW
        - PREDICTIVE_ROUTING_MODEL_VIEW
        - PREDICTIVE_ROUTING_IMPACT_VIEW
        - DATA_ACTIONS_PERFORMANCE_SUMMARY_VIEW
        - DATA_ACTIONS_PERFORMANCE_DETAIL_VIEW
        - AGENT_TIMELINE_SUMMARY_VIEW
        - AGENT_TIMELINE_DETAIL_VIEW
        - AGENT_LOGIN_LOGOUT_SUMMARY_VIEW
        - AGENT_LOGIN_LOGOUT_DETAIL_VIEW
        - CAMPAIGN_PERFORMANCE_SUMMARY_VIEW
        - CAMPAIGN_PERFORMANCE_DETAIL_VIEW
        - KNOWLEDGE_PERFORMANCE_VIEW
        - AGENT_SCORECARD_INSIGHTS_SUMMARY_VIEW
        - AGENT_SCORECARD_INSIGHTS_DETAIL_VIEW
        - QUEUE_WRAPUP_DETAIL_VIEW
        - INTERACTION_DETAIL_VIEW
        - CAMPAIGN_INTERACTION_DETAIL_VIEW
        - CAMPAIGN_ATTEMPT_DETAIL_VIEW
        - WORKITEM_PERFORMANCE_SUMMARY_VIEW
        - AGENT_ASSIST_PERFORMANCE_VIEW
        - CONTACT_CENTER_PERFORMANCE_VIEW
        - QUEUE_ROUTING_PERFORMANCE_VIEW
        - AGENT_WORKITEM_PERFORMANCE_SUMMARY_VIEW
        - AGENT_WORKITEM_PERFORMANCE_DETAIL_VIEW
        - QUEUE_WORKITEM_PERFORMANCE_SUMMARY_VIEW
        - QUEUE_WORKITEM_PERFORMANCE_DETAIL_VIEW
        - EMAIL_AGENT_PERFORMANCE_SUMMARY_VIEW
        - EMAIL_AGENT_PERFORMANCE_DETAIL_VIEW
        - MESSAGING_AGENT_PERFORMANCE_SUMMARY_VIEW
        - MESSAGING_AGENT_PERFORMANCE_DETAIL_VIEW
        - EMAIL_QUEUE_PERFORMANCE_SUMMARY_VIEW
        - EMAIL_QUEUE_PERFORMANCE_DETAIL_VIEW
        - MESSAGING_QUEUE_PERFORMANCE_SUMMARY_VIEW
        - MESSAGING_QUEUE_PERFORMANCE_DETAIL_VIEW
        - SOCIAL_LISTENING_VIEW
        - SOCIAL_LISTENING_POSTS_VIEW
        - AGENT_PERFORMANCE_TIMELINE_DETAIL_VIEW
        - DASHBOARD_SLIDESHOWS
        - DASHBOARD_SLIDESHOWS_DETAIL
        - AGENT_COPILOT_PERFORMANCE_VIEW
        - AGENT_ASSIGNED_EVALUATION_ME_VIEW
        - VIRTUAL_AGENT_PERFORMANCE_VIEW
        - CONTENT_EXPLORATION_VIEW
        - EVALUATION_PERFORMANCE_SUMMARY_VIEW
        - EVALUATION_PERFORMANCE_DETAIL_VIEW
        - EVALUATION_PERFORMANCE_QUESTION_GROUP_DETAIL_VIEW
        - EVALUATION_PERFORMANCE_QUESTION_DETAIL_VIEW
        - QUEUE_WORKITEM_ACTIVITY_SUMMARY_VIEW
        - QUEUE_WORKITEM_ACTIVITY_DETAIL_VIEW
        - DIGITAL_ADOPTION_VIEW
        - DIGITAL_INTENT_VIEW
        - DIGITAL_PERFORMANCE_VIEW
        - COPILOT_USAGE_VIEW
        - PREDICTIVE_ROUTING_THROUGHPUT_VIEW
        - QUEUE_SKILL_EXPRESSION_PERFORMANCE_VIEW
        - AGENTIC_VIRTUAL_AGENT_PERFORMANCE_VIEW
        - CALLBACK_QUEUE_PERFORMANCE_SUMMARY_VIEW
        - CALLBACK_QUEUE_PERFORMANCE_DETAIL_VIEW
      filter:
        description: Filters to apply to create the view
        $ref: '#/definitions/ViewFilter'
      read:
        type: boolean
        description: Indicates if the request has been marked as read
      locale:
        type: string
        description: The locale used for localization of the exported data, i.e. en-US, es
      hasFormatDurations:
        type: boolean
        description: Indicates if durations are formatted in hh:mm:ss format instead of ms
      hasSplitFilters:
        type: boolean
        description: Indicates if filters will be split in aggregate detail exports
      excludeEmptyRows:
        type: boolean
        description: Excludes empty rows from the exports
      hasSplitByMedia:
        type: boolean
        description: Indicates if media type will be split in aggregate detail exports
      hasSummaryRow:
        type: boolean
        description: Indicates if summary row needs to be present in exports
      csvDelimiter:
        type: string
        description: The user supplied csv delimiter string value either of type 'comma' or 'semicolon' permitted for the export request
        enum:
        - SEMICOLON
        - COMMA
      selectedColumns:
        type: array
        description: The list of ordered selected columns from the export view by the user
        items:
          $ref: '#/definitions/SelectedColumns'
      hasCustomParticipantAttributes:
        type: boolean
        description: Indicates if custom participant attributes will be exported
      recipientEmails:
        type: array
        description: The list of email recipients for the exports
        items:
          type: string
      includeDurationFormatInHeader:
        type: boolean
        description: Indicates whether to include selected duration format to the column headers
      durationFormat:
        type: string
        description: Indicates the duration format for the exports
        enum:
        - Seconds
        - Milliseconds
        - Hhmmss
        - Hms
      chartColumns:
        type: array
        description: The list of columns for which chart is going to be displayed in export
        items:
          $ref: '#/definitions/ChartColumn'
  TeamActivityEntityData:
    type: object
    required:
    - activityDate
    properties:
      activityDate:
        type: string
        format: date-time
        description: 'The time at which the activity was observed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      organizationPresenceId:
        type: string
        description: Organization presence identifier
      presenceDate:
        type: string
        format: date-time
        description: 'Date of the latest presence change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      queueId:
        type: string
        description: Queue identifier
      queueMembershipStatus:
        type: string
        description: Queue membership status (e.g. active or inactive)
      routingStatus:
        type: string
        description: Agent routing status
      routingStatusDate:
        type: string
        format: date-time
        description: 'Date of the latest routing status change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      systemPresence:
        type: string
        description: System presence
      teamId:
        type: string
        description: The team ID the user is a member of
      userId:
        type: string
        description: Unique identifier for the user
  RoutingStatusDetailQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/RoutingStatusDetailQueryPredicate'
  SessionsResponse:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/BotFlowSession'
      nextUri:
        type: string
      selfUri:
        type: string
      previousUri:
        type: string
  UserReferenceWithName:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
      name:
        type: string
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  ReportingTurnKnowledgeFeedback:
    type: object
    properties:
      searchId:
        type: string
        description: The ID of the original knowledge search that this feedback relates to.
      rating:
        type: integer
        format: int32
        description: The feedback rating for the search (1.0 - 5.0). 1 = Negative, 5 = Positive.
      documents:
        type: array
        description: The list of search documents that the feedback applies to.
        items:
          $ref: '#/definitions/ReportingTurnKnowledgeDocument'
  CaseManagementAsyncAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - associationType
          - caseId
          - caseplanId
          - conversationId
          - customerIntentId
          - divisionId
          - ownerId
          - priority
          - stageId
          - status
          - stepId
          - workitemId
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/CaseManagementAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nCaseAssociationsCreated
          - nCasesDeleted
          - nCasesOpened
          - nCasesOverSla
          - nCasesPurged
          - nCasesStatusChanged
          - nCasesTerminated
          - oCasesServiceLevel
          - tCasesResolved
          - tCasesStatus
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/CaseManagementAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
      pageSize:
        type: integer
        format: int32
        description: The number of results per page
  AnalyticsConversationWithoutAttributesMultiGetResponse:
    type: object
    properties:
      conversations:
        type: array
        items:
          $ref: '#/definitions/AnalyticsConversationWithoutAttributes'
  ErrorBody:
    type: object
    properties:
      message:
        type: string
      code:
        type: string
      status:
        type: integer
        format: int32
      entityId:
        type: string
      entityName:
        type: string
      messageWithParams:
        type: string
      messageParams:
        type: object
        additionalProperties:
          type: string
      contextId:
        type: string
      details:
        type: array
        items:
          $ref: '#/definitions/Detail'
      errors:
        type: array
        items:
          $ref: '#/definitions/ErrorBody'
      limit:
        $ref: '#/definitions/Limit'
  EvaluationAggregateDataContainer:
    type: object
    properties:
      group:
        type: object
        description: A mapping from dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        items:
          $ref: '#/definitions/StatisticalResponse'
  DashboardsSharedWith:
    type: object
    properties:
      userIds:
        type: array
        description: The list of user ids to share the dashboard with
        items:
          type: string
      teamIds:
        type: array
        description: The list of team ids to share the dashboard with
        items:
          type: string
  TaskManagementObservationGroupResult:
    type: object
    properties:
      queueId:
        type: string
        description: The queueId for this group.
      typeId:
        type: string
        description: The typeId for this group. Present when group includes typeId.
      assigneeId:
        type: string
        description: The assigneeId for this group. Present when group includes assigneeId.
      statusCategory:
        type: string
        description: The status category for this group. Present when group includes statusCategory.
        enum:
        - Open
        - InProgress
        - Waiting
        - Closed
        - Unknown
  ReportingTurnKnowledgeEvents:
    type: object
    properties:
      search:
        type: array
        description: The knowledge search data captured during this reporting turn.
        items:
          $ref: '#/definitions/ReportingTurnKnowledgeSearchEvent'
      feedback:
        type: array
        description: The knowledge feedback data captured during this reporting turn.
        items:
          $ref: '#/definitions/ReportingTurnKnowledgeFeedbackEvent'
  TaskManagementAsyncAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - assigneeId
          - caseId
          - divisionId
          - externalTag
          - queueId
          - reporterId
          - requestedLanguageId
          - requestedRouting
          - requestedRoutingSkillId
          - statusCategory
          - statusId
          - typeId
          - usedRouting
          - userId
          - workbinId
          - workitemId
          - wrapUpCode
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/TaskManagementAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nWorkitemsAcdCancelled
          - nWorkitemsAcdExpired
          - nWorkitemsAcdStarted
          - nWorkitemsAgentTransferred
          - nWorkitemsCreated
          - nWorkitemsDeclined
          - nWorkitemsDeleted
          - nWorkitemsDisconnected
          - nWorkitemsOffered
          - nWorkitemsOverSla
          - nWorkitemsPurged
          - nWorkitemsQueueTransferred
          - nWorkitemsStatusChanged
          - nWorkitemsTerminated
          - nWorkitemsTimedout
          - nWorkitemsTransferred
          - nWorkitemsWrapupAdded
          - nWorkitemsWrapupRemoved
          - oWorkitemsServiceLevel
          - tWorkitemsAgentFocusComplete
          - tWorkitemsAlert
          - tWorkitemsAnswered
          - tWorkitemsDirectAnswered
          - tWorkitemsFocus
          - tWorkitemsFocusComplete
          - tWorkitemsHandled
          - tWorkitemsHeld
          - tWorkitemsHeldComplete
          - tWorkitemsNotResponding
          - tWorkitemsParked
          - tWorkitemsQueueAnswered
          - tWorkitemsStatus
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/TaskManagementAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
      pageSize:
        type: integer
        format: int32
        description: The number of results per page
  RoutingActivityQuery:
    type: object
    required:
    - groupBy
    - metrics
    properties:
      metrics:
        type: array
        description: List of requested metrics
        items:
          $ref: '#/definitions/RoutingActivityQueryMetric'
      groupBy:
        type: array
        description: Dimension(s) to group by
        uniqueItems: true
        items:
          type: string
          enum:
          - queueId
      filter:
        description: Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/RoutingActivityQueryFilter'
      order:
        type: string
        description: Sort the result set in ascending/descending order. Default is ascending
        enum:
        - asc
        - desc
        - unordered
  ConversationAggregateQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - activeRouting
        - activeSkillId
        - addressFrom
        - addressTo
        - agentAssistantId
        - agentBullseyeRing
        - agentOwned
        - agentRank
        - agentScore
        - ani
        - assignerId
        - authenticated
        - canonicalExternalContactId
        - conversationId
        - conversationInitiator
        - convertedFrom
        - convertedTo
        - customerParticipation
        - deliveryStatus
        - destinationAddress
        - direction
        - disconnectType
        - divisionId
        - dnis
        - edgeId
        - eligibleAgentCount
        - errorCode
        - extendedDeliveryStatus
        - externalContactId
        - externalMediaCount
        - externalOrganizationId
        - externalTag
        - firstQueue
        - flaggedReason
        - flowInType
        - flowOutType
        - groupId
        - interactionType
        - journeyActionId
        - journeyActionMapId
        - journeyActionMapVersion
        - journeyCustomerId
        - journeyCustomerIdType
        - journeyCustomerSessionId
        - journeyCustomerSessionIdType
        - knowledgeBaseId
        - mediaCount
        - mediaType
        - messageType
        - originatingDirection
        - originatingSocialMediaPublic
        - outboundCampaignId
        - outboundContactId
        - outboundContactListId
        - participantName
        - peerId
        - proposedAgentId
        - provider
        - purpose
        - queueId
        - remote
        - removedSkillId
        - requestedLanguageId
        - requestedRouting
        - requestedRoutingSkillId
        - roomId
        - routingPriority
        - routingRing
        - routingRule
        - routingRuleType
        - scoredAgentId
        - selectedAgentId
        - selectedAgentRank
        - selfServed
        - sessionDnis
        - sessionId
        - skillExpressionId
        - stationId
        - teamId
        - usedRouting
        - userId
        - videoPresent
        - waitingInteractionCount
        - wrapUpCode
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension predicates
        $ref: '#/definitions/NumericRange'
  AsyncConversationQuery:
    type: object
    required:
    - interval
    properties:
      conversationFilters:
        type: array
        description: Filters that target conversation-level data
        items:
          $ref: '#/definitions/ConversationDetailQueryFilter'
      segmentFilters:
        type: array
        description: Filters that target individual segments within a conversation
        items:
          $ref: '#/definitions/SegmentDetailQueryFilter'
      evaluationFilters:
        type: array
        description: Filters that target evaluations
        items:
          $ref: '#/definitions/EvaluationDetailQueryFilter'
      surveyFilters:
        type: array
        description: Filters that target surveys
        items:
          $ref: '#/definitions/SurveyDetailQueryFilter'
      resolutionFilters:
        type: array
        description: Filters that target resolutions
        items:
          $ref: '#/definitions/ResolutionDetailQueryFilter'
      order:
        type: string
        description: Sort the result set in ascending/descending order. Default is ascending
        enum:
        - asc
        - desc
        - unordered
      orderBy:
        type: string
        description: 'Specify which data element within the result set to use for sorting. The options  to use as a basis for sorting the results: conversationStart, segmentStart, and segmentEnd. If not specified, the default is conversationStart'
        enum:
        - conversationStart
        - conversationEnd
        - segmentStart
        - segmentEnd
      interval:
        type: string
        format: interval
        description: 'Specifies the date and time range of data being queried. Results will include all conversations that had activity during the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
      limit:
        type: integer
        format: int32
        description: Specify number of results to be returned
      startOfDayIntervalMatching:
        type: boolean
        description: Add a filter to only include conversations that started after the beginning of the interval start date (UTC)
  BotAggregationSort:
    type: object
    required:
    - function
    - name
    properties:
      name:
        type: string
        description: Name of the metric used for sorting values.
        enum:
        - nBotSessionTurns
        - nBotSessions
        - oBotIntent
        - oBotSessionCollection
        - oBotSessionCollectionSelfServed
        - oBotSessionQuery
        - oBotSessionQuerySelfServed
        - oBotSessionTurn
        - oBotSlot
        - tBotDisconnect
        - tBotExit
        - tBotRecognitionFailure
        - tBotSession
      function:
        type: string
        description: Aggregation function used for the sort metric.
        enum:
        - average
        - count
        - max
        - min
        - sum
  FlowActivityQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/FlowActivityQueryPredicate'
  AnalyticsSessionMetric:
    type: object
    properties:
      emitDate:
        type: string
        format: date-time
        description: 'Metric emission date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      name:
        type: string
        description: Unique name of this metric
      value:
        type: integer
        format: int64
        description: The metric value
  TeamActivityQuery:
    type: object
    required:
    - groupBy
    - metrics
    properties:
      metrics:
        type: array
        description: List of requested metrics
        items:
          $ref: '#/definitions/TeamActivityQueryMetric'
      groupBy:
        type: array
        description: Dimension(s) to group by
        uniqueItems: true
        items:
          type: string
          enum:
          - teamId
      filter:
        description: Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/TeamActivityQueryFilter'
      order:
        type: string
        description: Sort the result set in ascending/descending order. Default is ascending
        enum:
        - asc
        - desc
        - unordered
  BotAggregateQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - askActionId
        - askActionResult
        - askActionType
        - botFinalIntent
        - botFlowSubType
        - botFlowType
        - botId
        - botIntent
        - botName
        - botProduct
        - botProvider
        - botRecognitionFailureReason
        - botResult
        - botSessionId
        - botSlot
        - botSlotMechanism
        - botVersion
        - conversationId
        - externalContactId
        - intermediateIntentName
        - knowledgeBaseId
        - languageCode
        - lastActionId
        - lastInputActionId
        - mediaType
        - messageType
        - previewMode
        - selfServed
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension predicates
        $ref: '#/definitions/NumericRange'
  EvaluationDetailQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/EvaluationDetailQueryPredicate'
  AnalyticsProperty:
    type: object
    properties:
      property:
        type: string
        description: User-defined rather than intrinsic system-observed values. These are tagged onto segments by other components within PureCloud or by API users directly.  This is the name of the user-defined property.
      propertyType:
        type: string
        description: Indicates what the data type is (e.g. integer vs string) and therefore how to evaluate what would constitute a match
        enum:
        - bool
        - integer
        - real
        - date
        - string
        - uuid
      value:
        type: string
        description: What property value to match against
  FlowExecutionAsyncAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/FlowExecutionAggregateDataContainer'
      cursor:
        type: string
        description: Cursor token to retrieve next page
  UserAsyncAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - userId
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/UserAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - tAgentRoutingStatus
          - tOrganizationPresence
          - tSystemPresence
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/UserAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
      pageSize:
        type: integer
        format: int32
        description: The number of results per page
  FlowActivityMetricValue:
    type: object
    properties:
      metric:
        type: string
        description: Metric
        enum:
        - oFlow
      qualifier:
        type: string
        description: Metric qualifier
      entityIds:
        type: array
        description: Entity ids for matching entities if details were requested
        uniqueItems: true
        items:
          type: string
      count:
        type: integer
        format: int32
        description: Metric count
  AnalyticsParticipantWithoutAttributes:
    type: object
    properties:
      externalContactId:
        type: string
        description: External contact identifier
      externalOrganizationId:
        type: string
        description: External organization identifier
      flaggedReason:
        type: string
        description: Reason for which participant flagged conversation
        enum:
        - general
      participantId:
        type: string
        description: Unique identifier for the participant
      participantName:
        type: string
        description: A human readable name identifying the participant
      purpose:
        type: string
        description: The participant's purpose
        enum:
        - acd
        - agent
        - api
        - botflow
        - campaign
        - customer
        - dialer
        - external
        - fax
        - group
        - inbound
        - ivr
        - manual
        - outbound
        - station
        - user
        - voicemail
        - voicesurveyflow
        - workflow
      screenRecording:
        type: boolean
        description: Flag determining if a screen recording was started or not
      teamId:
        type: string
        description: The team ID the user is a member of
      userId:
        type: string
        description: Unique identifier for the user
      sessions:
        type: array
        description: List of sessions associated to this participant
        items:
          $ref: '#/definitions/AnalyticsSession'
  ConversationActivityMetricValue:
    type: object
    properties:
      metric:
        type: string
        description: Metric
        enum:
        - oAlerting
        - oInteracting
        - oLongestInteracting
        - oLongestWaiting
        - oWaiting
      qualifier:
        type: string
        description: Metric qualifier
      entityIds:
        type: array
        description: Entity ids for matching entities if details were requested
        uniqueItems: true
        items:
          type: string
      count:
        type: integer
        format: int32
        description: Metric count
      calculatedMetricValue:
        type: integer
        format: int64
        description: Calculated metric value
  AnalyticsAgentStateCountsResponse:
    type: object
    properties:
      segmentCounts:
        type: array
        description: List of count by segment types
        items:
          $ref: '#/definitions/AgentStateSegmentTypeCount'
      presenceCounts:
        type: array
        description: List of count by presences
        items:
          $ref: '#/definitions/AgentStatePresenceCount'
      routingStatusCounts:
        type: array
        description: List of count by routing statuses
        items:
          $ref: '#/definitions/AgentStateRoutingStatusCount'
      isOutOfOfficeCounts:
        type: array
        description: List of count by out of office states
        items:
          $ref: '#/definitions/AgentStateIsOutOfOfficeCount'
  RateLimitAggregateQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - correlationId
        - entityId
        - limitName
        - max
        - namespace
        - timeUnit
        - userId
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension predicates
        $ref: '#/definitions/NumericRange'
  UserObservationQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/UserObservationQueryPredicate'
  SummaryAggregateQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - conversationId
        - copied
        - editedField
        - errorType
        - language
        - mediaType
        - messageType
        - presented
        - queueId
        - summaryGenerated
        - summaryId
        - summaryRating
        - triggerSourceId
        - triggerSourceOutcome
        - triggerSourceType
        - userId
        - wrapUpCodeRating
        - wrapUpCodeSuggestionSelected
        - wrapupCodesGenerated
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension predicates
        $ref: '#/definitions/NumericRange'
  AgentStateSegmentTypeCount:
    type: object
    properties:
      segmentType:
        type: string
        description: Segment type
        enum:
        - alert
        - barging
        - callback
        - coaching
        - contacting
        - converting
        - delay
        - dialing
        - hold
        - interact
        - ivr
        - monitoring
        - parked
        - scheduled
        - screenmonitoring
        - sharing
        - system
        - transmitting
        - unknown
        - uploading
        - voicemail
        - wrapup
      count:
        type: integer
        format: int32
        description: Count of segment type
  QueueObservationDataContainer:
    type: object
    properties:
      group:
        type: object
        description: A mapping from dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        items:
          $ref: '#/definitions/ObservationMetricData'
  Transcripts:
    type: object
    properties:
      exactMatch:
        type: array
        description: List of transcript contents which needs to satisfy exact match criteria
        items:
          type: string
      contains:
        type: array
        description: List of transcript contents which needs to satisfy contains criteria
        items:
          type: string
      doesNotContain:
        type: array
        description: List of transcript contents which needs to satisfy does not contain criteria
        items:
          type: string
      notSimilarTo:
        type: array
        description: List of words or phrases used to filter out transcripts that contain content similar to any item in this list
        items:
          type: string
  TaskManagementObservationDetailContainer:
    type: object
    properties:
      typeDetails:
        type: array
        description: Information about worktypes referenced in the results. Present when 'type' is included in the expands parameter.
        items:
          $ref: '#/definitions/WorktypeReference'
      assigneeDetails:
        type: array
        description: Information about assignees referenced in the results. Present when 'assignee' is included in the expands parameter.
        items:
          $ref: '#/definitions/UserReferenceWithName'
  WorktypeReference:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
      name:
        type: string
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  FlowActivityResponse:
    type: object
    properties:
      results:
        type: array
        description: Query results
        items:
          $ref: '#/definitions/FlowActivityData'
      entityIdDimension:
        type: string
        description: Dimension that is used as an entityId
        enum:
        - activeRouting
        - addressFrom
        - addressTo
        - agentScore
        - ani
        - conversationId
        - convertedFrom
        - convertedTo
        - direction
        - dnis
        - flowId
        - flowType
        - mediaType
        - participantName
        - queueId
        - requestedLanguageId
        - requestedRouting
        - requestedRoutingSkillId
        - routingPriority
        - scoredAgentId
        - sessionId
        - teamId
        - usedRouting
        - userId
  KnowledgeAggregateDataContainer:
    type: object
    properties:
      group:
        type: object
        description: A mapping from dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        items:
          $ref: '#/definitions/StatisticalResponse'
  TeamActivityQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/TeamActivityQueryPredicate'
  TaskManagementObservationQueryResponse:
    type: object
    properties:
      results:
        type: array
        description: Query results grouped by the specified dimensions supplied in the groupBy parameter. Each result contains metrics for a specific group combination.
        items:
          $ref: '#/definitions/TaskManagementObservationResult'
      details:
        description: Details about entities contained in results. Provides expanded information when requested through the expands parameter.
        $ref: '#/definitions/TaskManagementObservationDetailContainer'
      cursors:
        description: Cursor tokens to be used for navigating paginated results
        $ref: '#/definitions/Cursors'
      nextUri:
        type: string
        description: A URI to the next page in the listing.
  UserActivityQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/UserActivityQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/UserActivityQueryPredicate'
  FlowExecutionAggregateQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/FlowExecutionAggregateQueryPredicate'
  ActionAsyncAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/ActionAggregateDataContainer'
      cursor:
        type: string
        description: Cursor token to retrieve next page
  Widget:
    type: object
    required:
    - type
    properties:
      row:
        type: integer
        description: The row number for the specific dashboard widget configuration.
      column:
        type: integer
        description: The column number for the specific dashboard widget configuration.
      title:
        type: string
        description: The title for the dashboard widget configuration.
      type:
        type: string
        description: The type of dashboard widget configuration.
        enum:
        - METRIC
        - CHART
        - PIE
        - HEAT_MAP
        - FREE_TEXT
        - AGENT_STATUS
        - REALTIME_ADHERENCE
        - WEB_CONTENT_URL
        - AGENT_ACTIVITY
      metrics:
        type: array
        description: The list of metrics for the dashboard widget configuration.
        items:
          type: string
          enum:
          - AVG_TALK_TIME
          - AVG_HOLD_TIME
          - AVG_ACW_TIME
          - AVG_WAIT_TIME
          - AVG_HANDLE_TIME
          - AVG_ALERT_TIME
          - AVG_ANSWER_TIME
          - AVG_ABANDON_TIME
          - TOTAL_TALK_TIME
          - TOTAL_HANDLE_TIME
          - TOTAL_HOLD_TIME
          - TOTAL_ACW_TIME
          - TOTAL_ALERT_TIME
          - MAX_ABANDON_TIME
          - MAX_WAIT_TIME
          - MAX_TALK_TIME
          - MAX_HOLD_TIME
          - MAX_ACW_TIME
          - MIN_ABANDON_TIME
          - MIN_WAIT_TIME
          - MIN_TALK_TIME
          - MIN_HOLD_TIME
          - MIN_ACW_TIME
          - ALERT_COUNT
          - OFFERED_COUNT
          - ABANDONED_COUNT
          - ABANDONED_PERCENT
          - SHORT_ABANDONED_COUNT
          - SHORT_ABANDONED_PERCENT
          - ABANDONED_NO_SHORT_COUNT
          - ABANDONED_NO_SHORT_PERCENT
          - ANSWERED_COUNT
          - ANSWERED_PERCENT
          - FLOWOUT_COUNT
          - FLOWOUT_PERCENT
          - OUTBOUND_COUNT
          - OUTBOUND_ATTEMPTED_COUNT
          - VOICEMAIL_COUNT
          - HANDLED_COUNT
          - HELD_COUNT
          - TRANSFERRED_COUNT
          - TRANSFERRED_PERCENT
          - WAITING_CURRENT
          - INTERACTING_CURRENT
          - HELD_CURRENT
          - ALERTING_CURRENT
          - SERVICE_LEVEL
          - OVER_SERVICE_LEVEL
          - ONLINE_AGENTS
          - AVAILABLE_AGENTS
          - AWAY_AGENTS
          - BREAK_AGENTS
          - MEAL_AGENTS
          - TRAINING_AGENTS
          - BUSY_AGENTS
          - MEETING_AGENTS
          - SYSTEM_AWAY_AGENTS
          - OFFLINE_AGENTS
          - ON_QUEUE_AGENTS
          - OFF_QUEUE_AGENTS
          - INTERACTING_AGENTS
          - ACW_AGENTS
          - COMMUNICATING_AGENTS
          - IDLE_AGENTS
          - NOT_RESPONDING_AGENTS
          - LONGEST_WAITING
          - LONGEST_INTERACTING
          - FLOW_ACTIVE_LONGEST
          - FLOW_ACTIVE_CURRENT
          - FLOW_ENTRIES_COUNT
          - FLOW_TOTAL_DURATION
          - FLOW_MAX_DURATION
          - FLOW_AVG_DURATION
          - FLOW_DISCONNECT_COUNT
          - FLOW_DISCONNECT_PERCENT
          - FLOW_TOTAL_DISCONNECT_DURATION
          - FLOW_AVG_DISCONNECT_DURATION
          - FLOW_MAX_DISCONNECT_DURATION
          - FLOW_FLOW_DISCONNECT
          - FLOW_FLOW_DISCONNECT_PERCENT
          - FLOW_SYSTEM_ERROR_DISCONNECT
          - FLOW_SYSTEM_ERROR_DISCONNECT_PERCENT
          - FLOW_CUSTOMER_DISCONNECT
          - FLOW_CUSTOMER_DISCONNECT_PERCENT
          - FLOW_SHORT_DISCONNECT
          - FLOW_SHORT_DISCONNECT_PERCENT
          - FLOW_EXIT_COUNT
          - FLOW_EXIT_PERCENT
          - FLOW_TOTAL_EXIT_DURATION
          - FLOW_MAX_EXIT_DURATION
          - FLOW_AVG_EXIT_DURATION
          - FLOW_ACD_EXIT_COUNT
          - FLOW_ACD_EXIT_PERCENT
          - FLOW_GROUP_EXIT_COUNT
          - FLOW_GROUP_EXIT_PERCENT
          - FLOW_NUMBER_EXIT_COUNT
          - FLOW_NUMBER_EXIT_PERCENT
          - FLOW_USER_EXIT_COUNT
          - FLOW_USER_EXIT_PERCENT
          - FLOW_FLOW_EXIT_COUNT
          - FLOW_FLOW_EXIT_PERCENT
          - FLOW_SECURE_FLOW_EXIT_COUNT
          - FLOW_SECURE_FLOW_EXIT_PERCENT
          - FLOW_ACD_VOICEMAIL_EXIT_COUNT
          - FLOW_ACD_VOICEMAIL_EXIT_PERCENT
          - FLOW_USER_VOICEMAIL_EXIT_COUNT
          - FLOW_USER_VOICEMAIL_EXIT_PERCENT
          - FLOW_OUTCOME_COUNT
          - FLOW_AVG_OUTCOME_DECIMAL
          - FLOW_OUTCOME_FAILURE_COUNT
          - FLOW_OUTCOME_FAILURE_PERCENT
          - FLOW_OUTCOME_SUCCESS_COUNT
          - FLOW_OUTCOME_SUCCESS_PERCENT
          - FLOW_OUTCOME_TOTAL_DURATION
          - FLOW_OUTCOME_MAX_DURATION
          - FLOW_OUTCOME_AVG_DURATION
          - FLOW_OUTCOME_MIN_DURATION
          - OFF_QUEUE_TIME
          - OFF_QUEUE_PERCENT
          - AVAILABLE_TIME
          - AVAILABLE_PERCENT
          - BUSY_TIME
          - BUSY_PERCENT
          - AWAY_TIME
          - AWAY_PERCENT
          - BREAK_TIME
          - BREAK_PERCENT
          - MEAL_TIME
          - MEAL_PERCENT
          - MEETING_TIME
          - MEETING_PERCENT
          - TRAINING_TIME
          - TRAINING_PERCENT
          - INTERACTING_TIME
          - INTERACTING_PERCENT
          - COMMUNICATING_TIME
          - COMMUNICATING_PERCENT
          - SYSTEM_AWAY_TIME
          - SYSTEM_AWAY_PERCENT
          - ON_QUEUE_TIME
          - ON_QUEUE_PERCENT
          - IDLE_TIME
          - IDLE_PERCENT
          - NOT_RESPONDING_TIME
          - NOT_RESPONDING_PERCENT
          - LOGGED_IN_TIME
          - OCCUPANCY_PERCENT
          - MIN_ALERT_TIME
          - MAX_ALERT_TIME
          - MIN_HANDLE_TIME
          - MAX_HANDLE_TIME
          - MIN_ANSWERED_TIME
          - MAX_ANSWERED_TIME
          - MIN_NOT_RESPONDING_TIME
          - MAX_NOT_RESPONDING_TIME
          - MET_SERVICE_LEVEL
          - WFM_ADHERENCE_STATUS
          - WFM_SCHEDULED_ACTIVITY
          - WFM_ADHERENCE_DURATION
          - AGENT_TITLE
          - AGENT_DEPARTMENT
          - AGENT_EXTENSION
          - AGENT_SKILLS
          - AGENT_LOCATION
          - AGENT_REPORTS_TO
          - AGENT_EMAIL
          - AGENT_ROLE
          - AGENT_GROUP
          - AGENT_TIME_IN_STATUS
          - AGENT_TIME_IN_ROUTING_STATUS
          - AGENT_STATUS
          - AGENT_SECONDARY_STATUS
          - AGENT_ROUTING_STATUS
          - AGENT_MEDIA_TYPES
          - ACW_COUNT
          - ANSWER_TRANSFERRED_PERCENT
          - FLOW_AVG_MILESTONE_DECIMAL
          - NOT_RESPONDING_COUNT
          - AVG_ACW_HANDLED
          - AVG_CONTACTING_TIME
          - AVG_DIALING_TIME
          - AVG_FLOWOUT_TIME
          - AVG_HOLD_HANDLED
          - AVG_MONITOR
          - BLIND_TRANSFER_COUNT
          - BLIND_TRANSFER_PERCENT
          - CONNECTED_COUNT
          - CONSULT_COUNT
          - CONSULT_TRANSFER_COUNT
          - CONSULT_TRANSFER_PERCENT
          - CONTACTING_COUNT
          - DIALING_COUNT
          - ERROR_COUNT
          - EXTERNAL_MEDIA_COUNT
          - MAX_CONTACTING_TIME
          - MAX_DIALING_TIME
          - MAX_FLOWOUT_TIME
          - FLOW_MILESTONE_COUNT
          - MIN_FLOWOUT_TIME
          - MAX_MONITOR
          - MIN_CONTACTING_TIME
          - MIN_DIALING_TIME
          - MIN_MONITOR
          - MONITOR_COUNT
          - MEDIA_COUNT
          - SERVICE_LEVEL_TARGET
          - SERVICE_LEVEL_TARGET_CURRENT
          - TALK_COUNT
          - TOTAL_ABANDON_TIME
          - TOTAL_NOT_RESPONDING_TIME
          - TOTAL_CONTACTING
          - TOTAL_DIALING
          - TOTAL_MONITOR
          - TOTAL_WAIT_TIME
          - WAIT_COUNT
          - PARK_COUNT
          - AVG_PARK_TIME
          - TOTAL_PARK_TIME
          - MIN_PARK_TIME
          - MAX_PARK_TIME
          - INBOUND_AUDIO_COUNT
          - OUTBOUND_AUDIO_COUNT
      displayText:
        type: string
        description: The display text for the dashboard widget configuration.
      displayTextColor:
        type: string
        description: The color of the display text for the dashboard widget configuration in RGB hexadecimal format (for example "#FF0000" represents red).
      webContentUrl:
        type: string
        description: The external web URL for the dashboard widget configuration.
      splitFilters:
        type: boolean
        description: Indicates each filter to be displayed individually.
      splitByMediaType:
        type: boolean
        description: Indicates that data for each media type should be shown individually.
      showLongest:
        type: boolean
        description: Indicates the display be the longest time.
      displayAsTable:
        type: boolean
        description: Indicates the widget to be displayed as table.
      showDuration:
        type: boolean
        description: Indicates the display to include duration.
      sortOrder:
        type: string
        description: The sort order of the table.
        enum:
        - ascending
        - descending
      sortKey:
        type: string
        description: The sort key of the table.
        enum:
        - Name
        - Duration
      entityLimit:
        type: integer
        format: int32
        description: Indicates the limit of displayed entities.
      displayAggregates:
        type: boolean
        description: Indicates whether to display aggregate across all entity and media type combination.
      isFullWidth:
        type: boolean
        description: Indicates whether a widget should take the full width of a dashboard or be shown only in a single slot.
      showPercentageChange:
        type: boolean
        description: Indicates whether a widget should show the percentage diff between two values.
      showProfilePicture:
        type: boolean
        description: Indicates whether a widget should show the profile picture of an agent.
      filter:
        description: The filters to be applied for dashboard widget configuration
        $ref: '#/definitions/ViewFilter'
      periods:
        type: array
        description: The list of periods for the dashboard widget configuration
        items:
          type: string
          enum:
          - NONE
          - CURRENT_HALF_HOUR
          - TODAY
          - YESTERDAY
          - THIS_WEEK
          - LAST_WEEK
          - THIS_MONTH
          - LAST_MONTH
          - PRIOR_7_DAYS
          - PAST_7_DAYS_TO_DATE
          - PRIOR_30_DAYS
          - PAST_30_DAYS_TO_DATE
          - PRIOR_3_MONTHS
      mediaTypes:
        type: array
        description: The list of media types for the dashboard widget configuration
        items:
          type: string
          enum:
          - callback
          - chat
          - cobrowse
          - email
          - internalmessage
          - message
          - screenmonitoring
          - screenshare
          - unknown
          - video
          - voice
      warnings:
        type: array
        description: List of warnings for dashboard widget configuration
        items:
          $ref: '#/definitions/Warning'
      showTimeInStatus:
        type: boolean
        description: Indicates the show time in status of a widget configuration.
      showOfflineAgents:
        type: boolean
        description: Indicates to show offline agent widget.
      selectedStatuses:
        type: array
        description: Indicates the selected statuses used to filter the agent widget in the dashboard.
        items:
          type: string
          enum:
          - Available
          - Away
          - Busy
          - Break
          - Meeting
          - Training
          - Meal
          - SystemAway
          - OnQueue
          - Interacting
          - NotResponding
          - Idle
          - Communicating
          - OffQueue
          - Online
          - Offline
      selectedSegmentTypes:
        type: array
        description: Indicates the selected segment types used to filter the agent activity in the dashboard.
        items:
          type: string
          enum:
          - alert
          - barging
          - callback
          - coaching
          - contacting
          - converting
          - delay
          - dialing
          - hold
          - interact
          - ivr
          - monitoring
          - parked
          - scheduled
          - screenmonitoring
          - sharing
          - system
          - transmitting
          - unknown
          - uploading
          - voicemail
          - wrapup
      agentInteractionSortOrder:
        type: string
        description: The sort order of the interactions in the agent status widget.
        enum:
        - ascending
        - descending
  TranscriptAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/TranscriptAggregateDataContainer'
  AnalyticsParticipant:
    type: object
    properties:
      externalContactId:
        type: string
        description: External contact identifier
      externalOrganizationId:
        type: string
        description: External organization identifier
      flaggedReason:
        type: string
        description: Reason for which participant flagged conversation
        enum:
        - general
      participantId:
        type: string
        description: Unique identifier for the participant
      participantName:
        type: string
        description: A human readable name identifying the participant
      purpose:
        type: string
        description: The participant's purpose
        enum:
        - acd
        - agent
        - api
        - botflow
        - campaign
        - customer
        - dialer
        - external
        - fax
        - group
        - inbound
        - ivr
        - manual
        - outbound
        - station
        - user
        - voicemail
        - voicesurveyflow
        - workflow
      screenRecording:
        type: boolean
        description: Flag determining if a screen recording was started or not
      teamId:
        type: string
        description: The team ID the user is a member of
      userId:
        type: string
        description: Unique identifier for the user
      sessions:
        type: array
        description: List of sessions associated to this participant
        items:
          $ref: '#/definitions/AnalyticsSession'
      attributes:
        type: object
        description: List of attributes associated to this participant
        additionalProperties:
          type: string
  AsyncQueryResponse:
    type: object
    properties:
      jobId:
        type: string
        description: Unique identifier for the async query execution. Can be used to check the status of the query and retrieve results.
  QueueObservationQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - mediaType
        - queueId
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension predicates
        $ref: '#/definitions/NumericRange'
  QueueObservationQuery:
    type: object
    required:
    - filter
    - metrics
    properties:
      filter:
        description: Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/QueueObservationQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - oActiveUsers
          - oAlerting
          - oInteracting
          - oLongestInteracting
          - oLongestWaiting
          - oMemberUsers
          - oOffQueueUsers
          - oOnQueueUsers
          - oUserPresences
          - oUserRoutingStatuses
          - oWaiting
      detailMetrics:
        type: array
        description: Metrics for which to include additional detailed observations
        items:
          type: string
          enum:
          - oActiveUsers
          - oAlerting
          - oInteracting
          - oMemberUsers
          - oOffQueueUsers
          - oOnQueueUsers
          - oUserPresences
          - oUserRoutingStatuses
          - oWaiting
  QueueObservationQueryResponse:
    type: object
    properties:
      systemToOrganizationMappings:
        type: object
        description: A mapping from system presence to a list of organization presence ids
        additionalProperties:
          type: array
          items:
            type: string
      results:
        type: array
        items:
          $ref: '#/definitions/QueueObservationDataContainer'
  AgentStateSessionFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/AgentStateSessionQueryClause'
      predicates:
        type: array
        description: Describes a <dimension> = <value> filter used to perform matching
        items:
          $ref: '#/definitions/AgentStateSessionQueryPredicate'
  BotFlowSession:
    type: object
    properties:
      id:
        type: string
        description: The ID of the bot session.
      flow:
        description: The flow associated to this bot session.
        $ref: '#/definitions/Entity'
      conversation:
        description: The conversation details, across potentially multiple Bot Flow sessions.
        $ref: '#/definitions/AddressableEntityRef'
      channel:
        description: Channel-specific information that describes the message channel/provider.
        $ref: '#/definitions/BotChannel'
      language:
        type: string
        description: The initial language of operation for the session.
      endLanguage:
        type: string
        description: The language of the session at the time the session ended
      botResult:
        type: string
        description: The reason for session termination.
        enum:
        - Unknown
        - ExitRequestedByUser
        - ExitRequestedByBot
        - ExitError
        - ExitRecognitionFailure
        - DisconnectRequestedByUser
        - DisconnectRequestedByBot
        - DisconnectSessionExpired
        - DisconnectError
        - DisconnectRecognitionFailure
        - TransferToACD
        - TransferToUser
        - TransferToGroup
        - TransferToNumber
        - TransferToUserVoicemail
        - TransferToGroupVoicemail
        - TransferToACDVoicemail
      botResultCategory:
        type: string
        description: The category of result for the session.
        enum:
        - Unknown
        - UserExit
        - BotExit
        - Error
        - RecognitionFailure
        - UserDisconnect
        - BotDisconnect
        - SessionExpired
        - Transfer
      dateCreated:
        type: string
        format: date-time
        description: 'Timestamp indicating when the session was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      dateCompleted:
        type: string
        format: date-time
        description: 'Timestamp indicating when the session was completed. Note: The ''interval'' query param uses this timestamp to filter the output. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  JourneyAggregationView:
    type: object
    required:
    - function
    - name
    - target
    properties:
      target:
        type: string
        description: Target metric name
        enum:
        - nDistinctJourneyActions
        - nDistinctJourneySessions
        - nJourneyActionsBlocked
        - nJourneyOutcomesAchieved
        - nJourneyOutcomesAttributed
        - nJourneySegmentsAssigned
        - nJourneySessions
        - nWebActionsAbandoned
        - nWebActionsAccepted
        - nWebActionsEngaged
        - nWebActionsErrored
        - nWebActionsFrequencyCapReached
        - nWebActionsIgnored
        - nWebActionsOffered
        - nWebActionsOfferedOutsideSchedule
        - nWebActionsQualified
        - nWebActionsQualifiedOutsideSchedule
        - nWebActionsRejected
        - nWebActionsStarted
        - nWebActionsTimedout
        - oJourneyOutcomeTouchpointValue
        - oJourneyOutcomeValue
      name:
        type: string
        description: A unique name for this view. Must be distinct from other views and built-in metric names.
      function:
        type: string
        description: Type of view you wish to create
        enum:
        - rangeBound
      range:
        description: Range of numbers for slicing up data
        $ref: '#/definitions/AggregationRange'
  TranscriptAggregateQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/TranscriptAggregateQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/TranscriptAggregateQueryPredicate'
  SurveyAsyncAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/SurveyAggregateDataContainer'
      cursor:
        type: string
        description: Cursor token to retrieve next page
  ObservationValue:
    type: object
    required:
    - observationDate
    properties:
      observationDate:
        type: string
        format: date-time
        description: 'The time at which the observation occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      conversationId:
        type: string
        description: Unique identifier for the conversation
      sessionId:
        type: string
        description: The unique identifier of this session
      requestedRoutingSkillIds:
        type: array
        description: Unique identifier for a skill requested for an interaction
        uniqueItems: true
        items:
          type: string
      requestedLanguageId:
        type: string
        description: Unique identifier for the language requested for an interaction
      routingPriority:
        type: integer
        format: int64
        description: Routing priority for the current interaction
      participantName:
        type: string
        description: A human readable name identifying the participant
      userId:
        type: string
        description: Unique identifier for the user
      direction:
        type: string
        description: The direction of the communication
        enum:
        - inbound
        - outbound
      convertedFrom:
        type: string
        description: Session media type that was converted from in case of a media type conversion
      convertedTo:
        type: string
        description: Session media type that was converted to in case of a media type conversion
      addressFrom:
        type: string
        description: The address that initiated an action
      addressTo:
        type: string
        description: The address receiving an action
      ani:
        type: string
        description: Automatic Number Identification (caller's number)
      dnis:
        type: string
        description: Dialed number identification service (number dialed by the calling party)
      teamId:
        type: string
        description: The team id the user is a member of
      requestedRoutings:
        type: array
        description: All routing types for requested/attempted routing methods
        uniqueItems: true
        items:
          type: string
          enum:
          - Bullseye
          - Conditional
          - Direct
          - Last
          - Manual
          - Predictive
          - Preferred
          - Standard
          - Vip
      usedRouting:
        type: string
        description: Complete routing method
        enum:
        - Bullseye
        - Conditional
        - Direct
        - Last
        - Manual
        - Predictive
        - Preferred
        - Standard
        - Vip
      scoredAgents:
        type: array
        items:
          $ref: '#/definitions/AnalyticsScoredAgent'
  KnowledgeAggregateQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/KnowledgeAggregateQueryPredicate'
  TranscriptTopics:
    type: object
    properties:
      includes:
        type: array
        description: List of topics which need to be included in exact match criteria. This field is not mutually exclusive with excludes topic list.
        items:
          type: string
      excludes:
        type: array
        description: List of topics which need to be excluded in exact match criteria. This field is not mutually exclusive with includes topic list.
        items:
          type: string
  EvaluationAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/EvaluationAggregateDataContainer'
  JourneyAsyncAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/JourneyAggregateDataContainer'
      cursor:
        type: string
        description: Cursor token to retrieve next page
  EvaluationAsyncAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/EvaluationAggregateDataContainer'
      cursor:
        type: string
        description: Cursor token to retrieve next page
  AgentCopilotAggregateQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - agentAssistantId
        - cannedResponseId
        - cannedResponseLibraryId
        - chunkCount
        - conversationId
        - engagementType
        - externalContactId
        - feedbackRating
        - hasAnswerHighlight
        - hasGeneratedAnswer
        - knowledgeBaseDocumentId
        - knowledgeBaseDocumentVersionId
        - knowledgeSettingId
        - mediaType
        - messageId
        - queueId
        - scriptId
        - scriptPageId
        - searchId
        - state
        - suggestionId
        - suggestionType
        - triggerType
        - userId
        - utteranceId
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension predicates
        $ref: '#/definitions/NumericRange'
  EvaluationDetailQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/EvaluationDetailQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/EvaluationDetailQueryPredicate'
  QueueObservationQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/QueueObservationQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/QueueObservationQueryPredicate'
  AgentStateCountsRequest:
    type: object
    properties:
      userFilter:
        description: Filters that target user-level data
        $ref: '#/definitions/AgentStateUserFilter'
      sessionFilter:
        description: Filters that target session-level data
        $ref: '#/definitions/AgentStateSessionFilter'
  FlowAsyncAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/FlowAggregateDataContainer'
      cursor:
        type: string
        description: Cursor token to retrieve next page
  RateLimitAggregationView:
    type: object
    required:
    - function
    - name
    - target
    properties:
      target:
        type: string
        description: Target metric name
        enum:
        - oRateLimitRecorded
      name:
        type: string
        description: A unique name for this view. Must be distinct from other views and built-in metric names.
      function:
        type: string
        description: Type of view you wish to create
        enum:
        - rangeBound
      range:
        description: Range of numbers for slicing up data
        $ref: '#/definitions/AggregationRange'
  ResolutionAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
        x-genesys-entity-type:
          value: INTERVAL
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - conversationId
          - externalContactId
          - mediaType
          - queueId
          - requestedRouting
          - usedRouting
          - userId
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/ResolutionAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nNextContactAvoided
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/ResolutionAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event and choosing "wrapUpDate" uses the date when conversation is ended
        enum:
        - eventTime
        - wrapUpDate
  KnowledgeAsyncAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - agentAssistantId
          - answerGenerationEnabled
          - appDeploymentId
          - appType
          - botFlowId
          - conversationChannelType
          - conversationId
          - documentEngagementType
          - externalContactId
          - feedbackCategory
          - feedbackId
          - feedbackRating
          - feedbackRatingType
          - feedbackRatingValue
          - feedbackReason
          - feedbackType
          - hasComment
          - hasRetrievedReferences
          - hasSearch
          - knowledgeBaseDocumentId
          - knowledgeBaseDocumentVariationId
          - knowledgeBaseDocumentVersionId
          - knowledgeBaseId
          - knowledgeSettingId
          - languageCode
          - mediaType
          - messageType
          - presentedDocumentsCount
          - queryType
          - queryTypeV3
          - queueId
          - searchId
          - searchQuery
          - selfServed
          - sessionId
          - surfacingMethod
          - userId
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/KnowledgeAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nDistinctKnowledgeSessions
          - nKnowledgeDocumentCopied
          - nKnowledgeDocumentFeedback
          - nKnowledgeDocumentPresented
          - nKnowledgeDocumentSurfaced
          - nKnowledgeDocumentViewed
          - nKnowledgeSearch
          - nKnowledgeSearchAnswered
          - nKnowledgeSearchFeedback
          - nKnowledgeSearchUnanswered
          - nKnowledgeSessions
          - nKnowledgeV3Search
          - oKnowledgeDocumentQuery
          - oKnowledgeDocumentQuerySelfServed
          - oKnowledgeSearch
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/KnowledgeAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
      queryType:
        type: string
        description: Query type to use. Use groupBy for all matching results, and topN/bottomN for N results ordered by the sortMetric. Default is groupBy.
        enum:
        - bottomN
        - groupBy
        - topN
      sortMetric:
        description: Required when requesting multiple metrics. Only applicable for topN/bottomN query type.
        $ref: '#/definitions/KnowledgeAggregationSort'
      limit:
        type: integer
        format: int32
        description: How many results you want in an ordered list. Only applicable for topN/bottomN query type.
      pageSize:
        type: integer
        format: int32
        description: The number of results per page
  AnalyticsUserDetailsQueryResponse:
    type: object
    properties:
      userDetails:
        type: array
        items:
          $ref: '#/definitions/AnalyticsUserDetail'
      aggregations:
        type: array
        items:
          $ref: '#/definitions/AggregationResult'
      totalHits:
        type: integer
        format: int32
  TranscriptAggregateDataContainer:
    type: object
    properties:
      group:
        type: object
        description: A mapping from dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        items:
          $ref: '#/definitions/StatisticalResponse'
  JourneyAggregateDataContainer:
    type: object
    properties:
      group:
        type: object
        description: A mapping from dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        items:
          $ref: '#/definitions/StatisticalResponse'
  TeamActivityData:
    type: object
    properties:
      group:
        type: object
        description: A mapping from grouping dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        description: Data for metrics
        items:
          $ref: '#/definitions/TeamActivityMetricValue'
      truncated:
        type: boolean
        description: Flag for a truncated list of entities. If truncated, the first half of the list of entities will contain the oldest entities and the second half the newest entities.
      entities:
        type: array
        description: Details for active entities
        items:
          $ref: '#/definitions/TeamActivityEntityData'
  TeamActivityQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/TeamActivityQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/TeamActivityQueryPredicate'
  Entity:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
  RoutingStatusDetailQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/RoutingStatusDetailQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/RoutingStatusDetailQueryPredicate'
  FlowObservationQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/FlowObservationQueryPredicate'
  FlowExecutionAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
        x-genesys-entity-type:
          value: INTERVAL
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - divisionId
          - flowId
          - flowObjectId
          - flowVersion
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/FlowExecutionAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nFlowExecutions
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/FlowExecutionAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
  UserActivityQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/UserActivityQueryPredicate'
  KnowledgeAggregateQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/KnowledgeAggregateQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/KnowledgeAggregateQueryPredicate'
  SummaryAsyncAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/SummaryAggregateDataContainer'
      cursor:
        type: string
        description: Cursor token to retrieve next page
  ResolutionAggregateQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/ResolutionAggregateQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/ResolutionAggregateQueryPredicate'
  RoutingActivityResponse:
    type: object
    properties:
      results:
        type: array
        description: Query results
        items:
          $ref: '#/definitions/RoutingActivityData'
      entityIdDimension:
        type: string
        description: Dimension that is used as an entityId
        enum:
        - organizationPresenceId
        - presenceDate
        - queueId
        - queueMembershipStatus
        - routingStatus
        - routingStatusDate
        - systemPresence
        - teamId
        - userId
  AnalyticsFlowOutcome:
    type: object
    properties:
      flowOutcome:
        type: string
        description: Combination of unique flow outcome identifier and its value separated by colon
      flowOutcomeEndTimestamp:
        type: string
        format: date-time
        description: The outcome ending timestamp in ISO 8601 format. This may be null if the outcome did not succeed.
      flowOutcomeId:
        type: string
        description: Unique identifier of a flow outcome
      flowOutcomeStartTimestamp:
        type: string
        format: date-time
        description: The outcome starting timestamp in ISO 8601 format
      flowOutcomeValue:
        type: string
        description: Flow outcome value, e.g. SUCCESS
  ActionAsyncAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - actionCategory
          - actionId
          - actionName
          - correlationId
          - errorType
          - integrationId
          - integrationName
          - responseStatus
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/ActionAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - tTotalExecution
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/ActionAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
      pageSize:
        type: integer
        format: int32
        description: The number of results per page
  AnalyticsUserPresenceRecord:
    type: object
    properties:
      startTime:
        type: string
        format: date-time
        description: 'The start time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      endTime:
        type: string
        format: date-time
        description: 'The end time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      systemPresence:
        type: string
        description: The user's system presence
        enum:
        - AVAILABLE
        - AWAY
        - BUSY
        - OFFLINE
        - IDLE
        - ON_QUEUE
        - MEAL
        - TRAINING
        - MEETING
        - BREAK
      organizationPresenceId:
        type: string
        description: The identifier for the user's organization presence
  AnalyticsResolution:
    type: object
    properties:
      eventTime:
        type: string
        format: date-time
        description: 'Specifies when an event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      queueId:
        type: string
        description: The ID of the last queue on which the conversation was handled.
      userId:
        type: string
        description: The ID of the last user who handled the conversation.
      nNextContactAvoided:
        type: integer
        format: int64
  SelectedColumns:
    type: object
    properties:
      columnOrder:
        type: integer
        format: int32
        description: Indicates the order/position of the selected column
      columnName:
        type: string
        description: Indicates enum name of the column from the export view
  FlowAggregateQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - activeRouting
        - activeSkillId
        - addressFrom
        - addressTo
        - agentAssistantId
        - agentBullseyeRing
        - agentOwned
        - agentRank
        - agentScore
        - ani
        - assignerId
        - authenticated
        - canonicalExternalContactId
        - conversationId
        - conversationInitiator
        - convertedFrom
        - convertedTo
        - customerParticipation
        - deliveryStatus
        - destinationAddress
        - direction
        - disconnectType
        - divisionId
        - dnis
        - edgeId
        - eligibleAgentCount
        - endingLanguage
        - entryReason
        - entryType
        - errorCode
        - exitReason
        - extendedDeliveryStatus
        - externalContactId
        - externalMediaCount
        - externalOrganizationId
        - externalTag
        - firstQueue
        - flaggedReason
        - flowId
        - flowInType
        - flowMilestoneId
        - flowName
        - flowOutType
        - flowOutcome
        - flowOutcomeId
        - flowOutcomeValue
        - flowSubType
        - flowType
        - flowVersion
        - groupId
        - interactionType
        - journeyActionId
        - journeyActionMapId
        - journeyActionMapVersion
        - journeyCustomerId
        - journeyCustomerIdType
        - journeyCustomerSessionId
        - journeyCustomerSessionIdType
        - knowledgeBaseId
        - mediaCount
        - mediaType
        - messageType
        - originatingDirection
        - outboundCampaignId
        - outboundContactId
        - outboundContactListId
        - participantName
        - peerId
        - proposedAgentId
        - provider
        - purpose
        - queueId
        - recognitionFailureReason
        - remote
        - removedSkillId
        - requestedLanguageId
        - requestedRouting
        - requestedRoutingSkillId
        - roomId
        - routingPriority
        - routingRing
        - routingRule
        - routingRuleType
        - scoredAgentId
        - selectedAgentId
        - selectedAgentRank
        - selfServed
        - sessionDnis
        - sessionId
        - skillExpressionId
        - startingLanguage
        - stationId
        - teamId
        - transferTargetAddress
        - transferTargetName
        - transferType
        - usedRouting
        - userId
        - videoPresent
        - waitingInteractionCount
        - wrapUpCode
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension predicates
        $ref: '#/definitions/NumericRange'
  RateLimitAggregateQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/RateLimitAggregateQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/RateLimitAggregateQueryPredicate'
  TranscriptAggregationView:
    type: object
    required:
    - function
    - name
    - target
    properties:
      target:
        type: string
        description: Target metric name
        enum:
        - nSpeechTextAnalyzedConversations
        - nTopicCommunications
        - oCustomerSentiment
        - oOverTalkSpeechInstances
        - oSentimentScore
        - tAgentSpeech
        - tCustomerSpeech
        - tOtherAudio
        - tOverTalkSpeech
        - tSilence
        - tTotalSpeechAndSilence
      name:
        type: string
        description: A unique name for this view. Must be distinct from other views and built-in metric names.
      function:
        type: string
        description: Type of view you wish to create
        enum:
        - rangeBound
      range:
        description: Range of numbers for slicing up data
        $ref: '#/definitions/AggregationRange'
  UserDetailQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - userId
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension predicates
        $ref: '#/definitions/NumericRange'
  AnalyticsMediaEndpointStat:
    type: object
    properties:
      codecs:
        type: array
        description: The MIME type(s) of the audio encodings used by the audio streams belonging to this endpoint
        items:
          type: string
      discardedPackets:
        type: integer
        format: int64
        description: The total number of packets received too late or too early, jitter queue overrun or underrun, for all audio streams belonging to this endpoint
      duplicatePackets:
        type: integer
        format: int64
        description: The total number of packets received with the same sequence number as another one recently received (window of 64 packets), for all audio streams belonging to this endpoint
      eventTime:
        type: string
        format: date-time
        description: 'Specifies when an event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      invalidPackets:
        type: integer
        format: int64
        description: The total number of malformed or not RTP packets, unknown payload type, or discarded probation packets for all audio streams belonging to this endpoint
      maxLatencyMs:
        type: integer
        format: int64
        description: The maximum latency experienced by any audio stream belonging to this endpoint, in milliseconds
      minMos:
        type: number
        format: double
        description: The lowest estimated average MOS among all the audio streams belonging to this endpoint
      minRFactor:
        type: number
        format: double
        description: The lowest R-factor value among all of the audio streams belonging to this endpoint
      overrunPackets:
        type: integer
        format: int64
        description: The total number of packets for which there was no room in the jitter queue when it was received, for all audio streams belonging to this endpoint (also counted in discarded)
      receivedPackets:
        type: integer
        format: int64
        description: The total number of packets received for all audio streams belonging to this endpoint (includes invalid, duplicate, and discarded packets)
      underrunPackets:
        type: integer
        format: int64
        description: The total number of packets received after their timestamp/seqnum has been played out, for all audio streams belonging to this endpoint (also counted in discarded)
  ReportingTurnIntent:
    type: object
    properties:
      name:
        type: string
        description: The name of the intent detected during this reporting turn.
      id:
        type: string
        description: The ID of the intent detected during this reporting turn.
      confidence:
        type: number
        format: double
        description: The confidence score of the intent detected during this reporting turn.
      slots:
        type: array
        description: The slots detected during this reporting turn.
        items:
          $ref: '#/definitions/ReportingTurnIntentSlot'
  PagingSpec:
    type: object
    required:
    - pageNumber
    - pageSize
    properties:
      pageSize:
        type: integer
        format: int32
        description: How many results per page
      pageNumber:
        type: integer
        format: int32
        description: How many pages in
  AnalyticsEvaluation:
    type: object
    properties:
      assigneeApplicable:
        type: boolean
        description: Indicates whether an assignee is applicable for the evaluation. Set to false when assignee is not applicable
      assigneeId:
        type: string
        description: UserId of the assignee
      calibrationId:
        type: string
        description: The calibration ID used for the purpose of training evaluators
      contextId:
        type: string
        description: A unique identifier for an evaluation form, regardless of version
      deleted:
        type: boolean
        description: Whether the evaluation has been deleted
      evaluationId:
        type: string
        description: Unique identifier for the evaluation
      evaluationStatus:
        type: string
        description: Status of evaluation
        enum:
        - Finished
        - InProgress
        - InReview
        - Pending
        - Retracted
      evaluatorId:
        type: string
        description: A unique identifier of the user who evaluated the interaction
      eventTime:
        type: string
        format: date-time
        description: 'Specifies when an evaluation occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      formId:
        type: string
        description: ID of the evaluation form used
      formName:
        type: string
        description: Name of the evaluation form used
      queueId:
        type: string
        description: The ID of the associated queue
      released:
        type: boolean
        description: Whether the evaluation has been released
      rescored:
        type: boolean
        description: Whether the evaluation has been rescored at least once
      systemSubmitted:
        type: boolean
        description: Whether the evaluation was auto submitted by the system
      userId:
        type: string
        description: ID of the agent the evaluation was performed against
      oTotalCriticalScore:
        type: integer
        format: int64
      oTotalScore:
        type: integer
        format: int64
  AggregationResultEntry:
    type: object
    properties:
      count:
        type: integer
        format: int64
      value:
        type: string
        description: For termFrequency aggregations
      gte:
        type: number
        description: For numericRange aggregations
      lt:
        type: number
        description: For numericRange aggregations
  DashboardConfigurationListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/DashboardConfiguration'
      pageSize:
        type: integer
        format: int32
      pageNumber:
        type: integer
        format: int32
      total:
        type: integer
        format: int64
      firstUri:
        type: string
        format: uri
      nextUri:
        type: string
        format: uri
      previousUri:
        type: string
        format: uri
      lastUri:
        type: string
        format: uri
      selfUri:
        type: string
        format: uri
      pageCount:
        type: integer
        format: int32
  EvaluationAggregateQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - assigneeApplicable
        - assigneeId
        - calibrationId
        - contextId
        - conversationId
        - conversationStart
        - divisionId
        - evaluationContextId
        - evaluationCreatedDate
        - evaluationId
        - evaluationReleaseDate
        - evaluatorId
        - formId
        - mediaType
        - queueId
        - released
        - rescored
        - systemSubmitted
        - teamId
        - userId
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension predicates
        $ref: '#/definitions/NumericRange'
  ReportingTurnKnowledgeDocument:
    type: object
    properties:
      id:
        type: string
        description: The ID of the knowledge document.
      question:
        type: string
        description: The the question that was used to match against the search query.
      answer:
        type: string
        description: The corresponding answer to the question.
      confidence:
        type: number
        format: double
        description: The confidence score of how well the question matched the search query.
  WorkitemStatusFilter:
    type: object
    properties:
      worktypeId:
        type: string
        description: Worktype ID belonging to the selected workitem status
      workitemStatusId:
        type: string
        description: Workitem status ID
  AnalyticsUserDetail:
    type: object
    properties:
      userId:
        type: string
        description: The identifier for the user
      primaryPresence:
        type: array
        description: The presence records for the user
        items:
          $ref: '#/definitions/AnalyticsUserPresenceRecord'
      routingStatus:
        type: array
        description: The ACD routing status records for the user
        items:
          $ref: '#/definitions/AnalyticsRoutingStatusRecord'
  UserObservationQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/UserObservationDataContainer'
  BotChannel:
    type: object
    required:
    - inputModes
    - name
    - outputModes
    - userAgent
    properties:
      name:
        type: string
        description: The name of the channel.
        enum:
        - Chat
        - Call
        - Messaging
      inputModes:
        type: array
        description: The input modes for the channel.
        uniqueItems: true
        items:
          type: string
          enum:
          - Text
          - Voice
          - DTMF
      outputModes:
        type: array
        description: The output modes for the channel.
        uniqueItems: true
        items:
          type: string
          enum:
          - Text
          - Voice
      userAgent:
        description: Information about the end user agent calling the bot flow.
        $ref: '#/definitions/TextBotUserAgent'
    description: Channel information relevant to a bot flow.
  DataAvailabilityResponse:
    type: object
    properties:
      dataAvailabilityDate:
        type: string
        format: date-time
        description: 'Date and time before which data is guaranteed to be available in the datalake. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  RoutingActivityQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/RoutingActivityQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/RoutingActivityQueryPredicate'
  Warning:
    type: object
    properties:
      value:
        type: integer
        description: The value for the warning configuration.
      rangeType:
        type: string
        description: The range type for the warning configuration.
        enum:
        - OVER
        - UNDER
        - BETWEEN
      color:
        type: string
        description: The color for the warning configuration in RGB hexadecimal format (for example "#FF0000" represents red).
  SurveyAggregateDataContainer:
    type: object
    properties:
      group:
        type: object
        description: A mapping from dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        items:
          $ref: '#/definitions/StatisticalResponse'
  TeamActivityQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - organizationPresenceId
        - presenceDate
        - queueId
        - queueMembershipStatus
        - routingStatus
        - routingStatusDate
        - systemPresence
        - teamId
        - userId
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
  ResolutionDetailQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/ResolutionDetailQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/ResolutionDetailQueryPredicate'
  ResolutionDetailQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      metric:
        type: string
        description: Left hand side for metric predicates
        enum:
        - nNextContactAvoided
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for metric predicates
      range:
        description: Right hand side for metric predicates
        $ref: '#/definitions/NumericRange'
  BotAsyncAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/BotAggregateDataContainer'
      cursor:
        type: string
        description: Cursor token to retrieve next page
  AsyncUserDetailsQuery:
    type: object
    required:
    - interval
    properties:
      interval:
        type: string
        format: interval
        description: 'Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
      userFilters:
        type: array
        description: Filters that target the users to retrieve data for
        items:
          $ref: '#/definitions/UserDetailQueryFilter'
      presenceFilters:
        type: array
        description: Filters that target system and organization presence-level data
        items:
          $ref: '#/definitions/PresenceDetailQueryFilter'
      routingStatusFilters:
        type: array
        description: Filters that target agent routing status-level data
        items:
          $ref: '#/definitions/RoutingStatusDetailQueryFilter'
      order:
        type: string
        description: Sort the result set in ascending/descending order. Default is ascending
        enum:
        - asc
        - desc
        - unordered
      limit:
        type: integer
        format: int32
        description: Specify number of results to be returned
  SurveyDetailQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/SurveyDetailQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/SurveyDetailQueryPredicate'
  TranscriptAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
        x-genesys-entity-type:
          value: INTERVAL
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - addressFrom
          - addressTo
          - ani
          - categoryId
          - channel
          - conversationId
          - direction
          - divisionId
          - dnis
          - flowId
          - flowVersion
          - mediaType
          - messageType
          - queueId
          - teamId
          - topicId
          - userId
          - wrapUpCode
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/TranscriptAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nSpeechTextAnalyzedConversations
          - nTopicCommunications
          - oCustomerSentiment
          - oOverTalkSpeechInstances
          - oSentimentScore
          - tAgentSpeech
          - tCustomerSpeech
          - tOtherAudio
          - tOverTalkSpeech
          - tSilence
          - tTotalSpeechAndSilence
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/TranscriptAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
      queryType:
        type: string
        description: Query type to use. Use groupBy for all matching results, and topN/bottomN for N results ordered by the sortMetric. Default is groupBy.
        enum:
        - bottomN
        - groupBy
        - topN
      sortMetric:
        description: Required when requesting multiple metrics. Only applicable for topN/bottomN query type.
        $ref: '#/definitions/TranscriptAggregationSort'
      limit:
        type: integer
        format: int32
        description: How many results you want in an ordered list. Only applicable for topN/bottomN query type.
  AddressableEntityRef:
    type: object
    properties:
      id:
        type: string
      selfUri:
        type: string
        format: uri
  AsyncQueryStatus:
    type: object
    properties:
      state:
        type: string
        description: The current state of the asynchronous query
        enum:
        - QUEUED
        - PENDING
        - FAILED
        - CANCELLED
        - FULFILLED
        - EXPIRED
      errorMessage:
        type: string
        description: The error associated with the current query, if the state is FAILED
      expirationDate:
        type: string
        format: date-time
        description: 'The time at which results for this query will expire. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      submissionDate:
        type: string
        format: date-time
        description: 'The time at which the query was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      completionDate:
        type: string
        format: date-time
        description: 'The time at which the query completed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  SegmentDetailQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/SegmentDetailQueryPredicate'
  AgentCopilotAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/AgentCopilotAggregateDataContainer'
  RateLimitAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/RateLimitAggregateDataContainer'
  AnalyticsReportingSettings:
    type: object
    properties:
      piiMaskingEnabled:
        type: boolean
        description: Indication of whether or not personal data is masked in data export and the Analytics/Reporting UI
      queueAgentAccessObfuscation:
        type: boolean
        description: Indication of whether or not to obfuscate export data from the Queue Agent Details view based on User ACL
      myInteractionsPiiMaskingEnabled:
        type: boolean
        description: Indicates whether PII data is masked in My Interaction export and the Analytics/Reporting UI
  ConversationActivityQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - activeRouting
        - addressFrom
        - addressTo
        - agentScore
        - ani
        - conversationId
        - convertedFrom
        - convertedTo
        - direction
        - dnis
        - mediaType
        - participantName
        - queueId
        - requestedLanguageId
        - requestedRouting
        - requestedRoutingSkillId
        - routingPriority
        - scoredAgentId
        - sessionId
        - teamId
        - usedRouting
        - userId
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
  UserActivityQuery:
    type: object
    required:
    - groupBy
    - metrics
    properties:
      metrics:
        type: array
        description: List of requested metrics
        items:
          $ref: '#/definitions/UserActivityQueryMetric'
      groupBy:
        type: array
        description: Dimension(s) to group by
        uniqueItems: true
        items:
          type: string
          enum:
          - userId
      filter:
        description: Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/UserActivityQueryFilter'
      order:
        type: string
        description: Sort the result set in ascending/descending order. Default is ascending
        enum:
        - asc
        - desc
        - unordered
  FlowActivityData:
    type: object
    properties:
      group:
        type: object
        description: A mapping from grouping dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        description: Data for metrics
        items:
          $ref: '#/definitions/FlowActivityMetricValue'
      truncated:
        type: boolean
        description: Flag for a truncated list of entities. If truncated, the first half of the list of entities will contain the oldest entities and the second half the newest entities.
      entities:
        type: array
        description: Details for active entities
        items:
          $ref: '#/definitions/FlowActivityEntityData'
  ActionAggregateDataContainer:
    type: object
    properties:
      group:
        type: object
        description: A mapping from dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        items:
          $ref: '#/definitions/StatisticalResponse'
  UserAggregationView:
    type: object
    required:
    - function
    - name
    - target
    properties:
      target:
        type: string
        description: Target metric name
        enum:
        - tAgentRoutingStatus
        - tOrganizationPresence
        - tSystemPresence
      name:
        type: string
        description: A unique name for this view. Must be distinct from other views and built-in metric names.
      function:
        type: string
        description: Type of view you wish to create
        enum:
        - rangeBound
      range:
        description: Range of numbers for slicing up data
        $ref: '#/definitions/AggregationRange'
  ActionAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/ActionAggregateDataContainer'
  BotAggregateDataContainer:
    type: object
    properties:
      group:
        type: object
        description: A mapping from dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        items:
          $ref: '#/definitions/StatisticalResponse'
  PresenceDetailQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/PresenceDetailQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/PresenceDetailQueryPredicate'
  AnalyticsProposedAgent:
    type: object
    properties:
      agentRank:
        type: integer
        format: int32
        description: Proposed agent rank for this conversation from predictive routing (lower is better)
      proposedAgentId:
        type: string
        description: Unique identifier for the agent that was proposed by predictive routing
  CaseManagementAsyncAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/CaseManagementAggregateDataContainer'
      cursor:
        type: string
        description: Cursor token to retrieve next page
  ConversationAggregateQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/ConversationAggregateQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/ConversationAggregateQueryPredicate'
  ResolutionAggregateDataContainer:
    type: object
    properties:
      group:
        type: object
        description: A mapping from dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        items:
          $ref: '#/definitions/StatisticalResponse'
  ConversationAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
        x-genesys-entity-type:
          value: INTERVAL
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - activeRouting
          - activeSkillId
          - addressFrom
          - addressTo
          - agentAssistantId
          - agentBullseyeRing
          - agentOwned
          - agentRank
          - agentScore
          - ani
          - assignerId
          - authenticated
          - conversationId
          - conversationInitiator
          - convertedFrom
          - convertedTo
          - customerParticipation
          - deliveryStatus
          - destinationAddress
          - direction
          - disconnectType
          - divisionId
          - dnis
          - edgeId
          - eligibleAgentCount
          - errorCode
          - extendedDeliveryStatus
          - externalContactId
          - externalMediaCount
          - externalOrganizationId
          - externalTag
          - firstQueue
          - flaggedReason
          - flowInType
          - flowOutType
          - groupId
          - interactionType
          - journeyActionId
          - journeyActionMapId
          - journeyActionMapVersion
          - journeyCustomerId
          - journeyCustomerIdType
          - journeyCustomerSessionId
          - journeyCustomerSessionIdType
          - knowledgeBaseId
          - mediaCount
          - mediaType
          - messageType
          - originatingDirection
          - originatingSocialMediaPublic
          - outboundCampaignId
          - outboundContactId
          - outboundContactListId
          - participantName
          - peerId
          - proposedAgentId
          - provider
          - purpose
          - queueId
          - remote
          - removedSkillId
          - requestedLanguageId
          - requestedRouting
          - requestedRoutingSkillId
          - roomId
          - routingPriority
          - routingRing
          - routingRule
          - routingRuleType
          - scoredAgentId
          - selectedAgentId
          - selectedAgentRank
          - selfServed
          - sessionDnis
          - sessionId
          - skillExpressionId
          - stationId
          - teamId
          - usedRouting
          - userId
          - videoPresent
          - waitingInteractionCount
          - wrapUpCode
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/ConversationAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nBlindTransferred
          - nBotInteractions
          - nCallbackAttempts
          - nCallbackOverSla
          - nCallbackScheduled
          - nCfcOffered
          - nCobrowseSessions
          - nConnected
          - nConsult
          - nConsultTransferred
          - nConversations
          - nError
          - nOffered
          - nOutbound
          - nOutboundAbandoned
          - nOutboundAttempted
          - nOutboundConnected
          - nOverSla
          - nStateTransitionError
          - nTakeover
          - nTransferred
          - oAudioMessageCount
          - oCallbackServiceLevel
          - oExternalAudioMessageCount
          - oExternalMediaCount
          - oMediaCount
          - oMessageCount
          - oMessageSegmentCount
          - oMessageTurn
          - oServiceLevel
          - oServiceTarget
          - oSkillExpressionApplications
          - tAbandon
          - tAcd
          - tActiveCallback
          - tActiveCallbackComplete
          - tAcw
          - tAgentResponseTime
          - tAgentVideoConnected
          - tAlert
          - tAnswered
          - tAverageAgentResponseTime
          - tAverageCustomerResponseTime
          - tBarging
          - tCallbackAbandon
          - tCallbackConnect
          - tCallbackNotReached
          - tCallbackVirtualWait
          - tCfcAbandon
          - tCfcAcd
          - tCfcAnswered
          - tCfcFlowOut
          - tCoaching
          - tCoachingComplete
          - tConnected
          - tContacting
          - tDialing
          - tFirstConnect
          - tFirstDial
          - tFirstEngagement
          - tFirstResponse
          - tFlowOut
          - tHandle
          - tHeld
          - tHeldComplete
          - tIvr
          - tMonitoring
          - tMonitoringComplete
          - tNotResponding
          - tPark
          - tParkComplete
          - tScreenMonitoring
          - tShortAbandon
          - tSnippetRecord
          - tTalk
          - tTalkComplete
          - tTransmitting
          - tUserResponseTime
          - tVoicemail
          - tWait
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/ConversationAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
      queryType:
        type: string
        description: Query type to use. Use groupBy for all matching results, and topN/bottomN for N results ordered by the sortMetric. Default is groupBy.
        enum:
        - bottomN
        - groupBy
        - topN
      sortMetric:
        description: Required when requesting multiple metrics. Only applicable for topN/bottomN query type.
        $ref: '#/definitions/ConversationAggregationSort'
      limit:
        type: integer
        format: int32
        description: How many results you want in an ordered list. Only applicable for topN/bottomN query type.
  ConversationActivityResponse:
    type: object
    properties:
      results:
        type: array
        description: Query results
        items:
          $ref: '#/definitions/ConversationActivityData'
      entityIdDimension:
        type: string
        description: Dimension that is used as an entityId
        enum:
        - activeRouting
        - addressFrom
        - addressTo
        - agentScore
        - ani
        - conversationId
        - convertedFrom
        - convertedTo
        - direction
        - dnis
        - mediaType
        - participantName
        - queueId
        - requestedLanguageId
        - requestedRouting
        - requestedRoutingSkillId
        - routingPriority
        - scoredAgentId
        - sessionId
        - teamId
        - usedRouting
        - userId
  BotAsyncAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - askActionId
          - askActionResult
          - askActionType
          - botFinalIntent
          - botFlowSubType
          - botFlowType
          - botId
          - botIntent
          - botName
          - botProduct
          - botProvider
          - botRecognitionFailureReason
          - botResult
          - botSessionId
          - botSlot
          - botSlotMechanism
          - botVersion
          - conversationId
          - externalContactId
          - intermediateIntentName
          - knowledgeBaseId
          - languageCode
          - lastActionId
          - lastInputActionId
          - mediaType
          - messageType
          - previewMode
          - selfServed
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/BotAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nBotSessionTurns
          - nBotSessions
          - oBotIntent
          - oBotSessionCollection
          - oBotSessionCollectionSelfServed
          - oBotSessionQuery
          - oBotSessionQuerySelfServed
          - oBotSessionTurn
          - oBotSlot
          - tBotDisconnect
          - tBotExit
          - tBotRecognitionFailure
          - tBotSession
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/BotAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
      queryType:
        type: string
        description: Query type to use. Use groupBy for all matching results, and topN/bottomN for N results ordered by the sortMetric. Default is groupBy.
        enum:
        - bottomN
        - groupBy
        - topN
      sortMetric:
        description: Required when requesting multiple metrics. Only applicable for topN/bottomN query type.
        $ref: '#/definitions/BotAggregationSort'
      limit:
        type: integer
        format: int32
        description: How many results you want in an ordered list. Only applicable for topN/bottomN query type.
      pageSize:
        type: integer
        format: int32
        description: The number of results per page
  ReportingTurnAction:
    type: object
    properties:
      actionId:
        type: string
        description: The ID of the action in the bot flow.
      actionName:
        type: string
        description: The name of the action in the bot flow.
      actionNumber:
        type: integer
        format: int32
        description: The number of the action in the bot flow.
      actionType:
        type: string
        enum:
        - AskForAuthenticationAction
        - AddFlowMilestoneAction
        - AskForNLUIntentAction
        - AskForBooleanAction
        - AskForPaymentAction
        - AskForSlotAction
        - AskSurveyQuestionAction
        - AskForNLUNextIntentAction
        - AssignCustomerSegmentAction
        - BotState
        - CallAgenticVirtualAgentAction
        - CallBotFlowAction
        - CallDigitalBotFlowAction
        - CallTaskAction
        - CallGuideAction
        - ClearSlotAction
        - ClearUtilizationLabelAction
        - DisconnectAction
        - EndTaskAction
        - ExitBotFlowAction
        - UpdateVariableAction
        - CommunicateAction
        - DecisionAction
        - FindEmergencyGroupAction
        - FindGrammarAction
        - FindGrammarByIdAction
        - FindGroupAction
        - FindLanguageSkillAction
        - FindQueueAction
        - FindQueueByIdAction
        - FindScheduleAction
        - FindScheduleGroupAction
        - FindSkillAction
        - FindSystemPromptAction
        - FindUserAction
        - FindUserByIdAction
        - FindUsersByIdAction
        - FindUserPromptAction
        - FindUtilizationLabelAction
        - FormAction
        - SwitchAction
        - DataAction
        - DataTableLookupAction
        - GetExternalContactAction
        - GetExternalOrganizationAction
        - GetAssignedCustomerSegmentsAction
        - LoopAction
        - ExitLoopAction
        - NextLoopAction
        - LoopUntilAction
        - SetActiveIntentAction
        - SetFlowOutcomeAction
        - InitializeFlowOutcomeAction
        - AskForStringAction
        - SendResponseAction
        - GetResponseAction
        - ExtractSecureDataAction
        - SecureAction
        - TransferTaskAction
        - DigitalMenuAction
        - WaitForInputAction
        - EvaluateScheduleAction
        - EvaluateScheduleGroupAction
        - PromoteExternalContactAction
        - ShowKnowledgeArticleAction
        - SendKnowledgeFeedbackAction
        - SetLocaleAction
        - ScreenPopAction
        - SetUtilizationLabelAction
        - SetWrapupCodeAction
        - TransferPureMatchAction
        - TransferUserAction
        - TransferGroupAction
        - TransferExternalAction
        - GetAttributesAction
        - SetAttributesAction
        - SendInteractiveApplicationAction
        - SendRichLinkAction
        - SendDigitalContentAction
        - AgenticAskForIntentAction
        - Unknown
  FlowAggregateQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/FlowAggregateQueryPredicate'
  UserObservationDataContainer:
    type: object
    properties:
      group:
        type: object
        description: A mapping from dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        items:
          $ref: '#/definitions/ObservationMetricData'
  TranscriptAggregateQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/TranscriptAggregateQueryPredicate'
  ReportingTurn:
    type: object
    properties:
      userInput:
        type: string
        description: The chosen user input associated with this reporting turn.
      botPrompts:
        type: array
        description: The bot prompts associated with this reporting turn.
        items:
          type: string
      sessionId:
        type: string
        description: The bot session ID that this reporting turn is grouped under.
      conversation:
        description: The conversation details, across potentially multiple Bot Flow sessions.
        $ref: '#/definitions/AddressableEntityRef'
      askAction:
        description: The bot flow 'ask' action associated with this reporting turn (e.g. AskForIntent).
        $ref: '#/definitions/ReportingTurnAction'
      intent:
        description: The intent and associated slots detected during this reporting turn.
        $ref: '#/definitions/ReportingTurnIntent'
      knowledge:
        description: The knowledge data captured during this reporting turn.
        $ref: '#/definitions/ReportingTurnKnowledge'
      knowledgeBaseEvents:
        description: The knowledge data captured during this reporting turn.
        $ref: '#/definitions/ReportingTurnKnowledgeEvents'
      dateCreated:
        type: string
        format: date-time
        description: 'Timestamp indicating when the original turn was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      dateCompleted:
        type: string
        format: date-time
        description: 'Timestamp indicating when the original turn was completed. Note: The ''interval'' query param uses this timestamp to filter the output. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      askActionResult:
        type: string
        description: Result of the bot flow 'ask' action.
        enum:
        - SuccessCollection
        - SuccessConfirmationYes
        - SuccessConfirmationNo
        - SkippedCollection
        - PartialCollection
        - GuardrailsViolation
        - NoMatchCollection
        - NoMatchConfirmation
        - AgentRequestedByUser
        - ConfirmationRequired
        - Error
        - ExpressionError
        - NoInputCollection
        - NoInputConfirmation
        - DisambiguationRequired
        - SuccessDisambiguation
        - SuccessDisambiguationNone
        - NoMatchDisambiguation
        - NoInputDisambiguation
      sessionEndDetails:
        description: The details related to end of bot flow session.
        $ref: '#/definitions/SessionEndDetails'
  FlowActivityScoredAgent:
    type: object
    properties:
      agentScore:
        type: integer
        format: int32
        description: Assigned agent score for this conversation (0 - 100, higher being better)
      scoredAgentId:
        type: string
        description: Unique identifier for the agent that was scored for this conversation
  AnalyticsUserDetailsAsyncQueryResponse:
    type: object
    properties:
      userDetails:
        type: array
        items:
          $ref: '#/definitions/AnalyticsUserDetail'
      cursor:
        type: string
        description: Optional cursor to indicate where to resume the results
      dataAvailabilityDate:
        type: string
        format: date-time
        description: 'Data available up to at least this datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  EvaluationAggregateQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/EvaluationAggregateQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/EvaluationAggregateQueryPredicate'
  AgentCopilotAggregationSort:
    type: object
    required:
    - function
    - name
    properties:
      name:
        type: string
        description: Name of the metric used for sorting values.
        enum:
        - nCannedResponseSuggestions
        - nDistinctConversations
        - nDistinctSuggestions
        - nKnowledgeAnswerSuggestions
        - nKnowledgeArticleSuggestions
        - nKnowledgeSearchSuggestions
        - nScriptSuggestions
      function:
        type: string
        description: Aggregation function used for the sort metric.
        enum:
        - average
        - count
        - max
        - min
        - sum
  TranscriptAggregateQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - addressFrom
        - addressTo
        - ani
        - categoryId
        - channel
        - conversationDuration
        - conversationId
        - direction
        - divisionId
        - dnis
        - flowId
        - flowVersion
        - handleTime
        - mediaType
        - messageType
        - queueId
        - resultsBy
        - teamId
        - topicId
        - userId
        - wrapUpCode
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension predicates
        $ref: '#/definitions/NumericRange'
  ResolutionAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/ResolutionAggregateDataContainer'
  NumericRange:
    type: object
    properties:
      gt:
        type: number
        description: Greater than
      gte:
        type: number
        description: Greater than or equal to
      lt:
        type: number
        description: Less than
      lte:
        type: number
        description: Less than or equal to
  BotAggregationView:
    type: object
    required:
    - function
    - name
    - target
    properties:
      target:
        type: string
        description: Target metric name
        enum:
        - nBotSessionTurns
        - nBotSessions
        - oBotIntent
        - oBotSessionCollection
        - oBotSessionCollectionSelfServed
        - oBotSessionQuery
        - oBotSessionQuerySelfServed
        - oBotSessionTurn
        - oBotSlot
        - tBotDisconnect
        - tBotExit
        - tBotRecognitionFailure
        - tBotSession
      name:
        type: string
        description: A unique name for this view. Must be distinct from other views and built-in metric names.
      function:
        type: string
        description: Type of view you wish to create
        enum:
        - rangeBound
      range:
        description: Range of numbers for slicing up data
        $ref: '#/definitions/AggregationRange'
  JourneyAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/JourneyAggregateDataContainer'
  AgentStateRoutingStatusCount:
    type: object
    properties:
      routingStatus:
        type: string
        description: Routing status
        enum:
        - UNKNOWN
        - OFF_QUEUE
        - IDLE
        - INTERACTING
        - NOT_RESPONDING
        - COMMUNICATING
      count:
        type: integer
        format: int32
        description: Count of users with this routing status
  UserObservationQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/UserObservationQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/UserObservationQueryPredicate'
  EvaluationAggregateQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/EvaluationAggregateQueryPredicate'
  FlowAsyncAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - activeRouting
          - activeSkillId
          - addressFrom
          - addressTo
          - agentAssistantId
          - agentBullseyeRing
          - agentOwned
          - agentRank
          - agentScore
          - ani
          - assignerId
          - authenticated
          - conversationId
          - conversationInitiator
          - convertedFrom
          - convertedTo
          - customerParticipation
          - deliveryStatus
          - destinationAddress
          - direction
          - disconnectType
          - divisionId
          - dnis
          - edgeId
          - eligibleAgentCount
          - endingLanguage
          - entryReason
          - entryType
          - errorCode
          - exitReason
          - extendedDeliveryStatus
          - externalContactId
          - externalMediaCount
          - externalOrganizationId
          - externalTag
          - firstQueue
          - flaggedReason
          - flowId
          - flowInType
          - flowMilestoneId
          - flowName
          - flowOutType
          - flowOutcome
          - flowOutcomeId
          - flowOutcomeValue
          - flowSubType
          - flowType
          - flowVersion
          - groupId
          - interactionType
          - journeyActionId
          - journeyActionMapId
          - journeyActionMapVersion
          - journeyCustomerId
          - journeyCustomerIdType
          - journeyCustomerSessionId
          - journeyCustomerSessionIdType
          - knowledgeBaseId
          - mediaCount
          - mediaType
          - messageType
          - originatingDirection
          - outboundCampaignId
          - outboundContactId
          - outboundContactListId
          - participantName
          - peerId
          - proposedAgentId
          - provider
          - purpose
          - queueId
          - recognitionFailureReason
          - remote
          - removedSkillId
          - requestedLanguageId
          - requestedRouting
          - requestedRoutingSkillId
          - roomId
          - routingPriority
          - routingRing
          - routingRule
          - routingRuleType
          - scoredAgentId
          - selectedAgentId
          - selectedAgentRank
          - selfServed
          - sessionDnis
          - sessionId
          - skillExpressionId
          - startingLanguage
          - stationId
          - teamId
          - transferTargetAddress
          - transferTargetName
          - transferType
          - usedRouting
          - userId
          - videoPresent
          - waitingInteractionCount
          - wrapUpCode
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/FlowAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nFlow
          - nFlowMilestone
          - nFlowOutcome
          - nFlowOutcomeFailed
          - oFlowMilestone
          - tFlow
          - tFlowDisconnect
          - tFlowExit
          - tFlowOutcome
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/FlowAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
      pageSize:
        type: integer
        format: int32
        description: The number of results per page
  EvaluationAsyncAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - assigneeApplicable
          - assigneeId
          - calibrationId
          - contextId
          - conversationId
          - divisionId
          - evaluationContextId
          - evaluationId
          - evaluatorId
          - formId
          - mediaType
          - queueId
          - released
          - rescored
          - systemSubmitted
          - teamId
          - userId
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/EvaluationAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nEvaluations
          - nEvaluationsDeleted
          - nEvaluationsRescored
          - oTotalCriticalScore
          - oTotalScore
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/EvaluationAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - conversationStart
        - evaluationCreatedDate
        - evaluationReleaseDate
        - eventTime
      pageSize:
        type: integer
        format: int32
        description: The number of results per page
  ResolutionDetailQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/ResolutionDetailQueryPredicate'
  KnowledgeAggregateQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - agentAssistantId
        - answerGenerationEnabled
        - appDeploymentId
        - appType
        - botFlowId
        - conversationChannelType
        - conversationId
        - documentEngagementType
        - externalContactId
        - feedbackCategory
        - feedbackId
        - feedbackRating
        - feedbackRatingType
        - feedbackRatingValue
        - feedbackReason
        - feedbackType
        - hasComment
        - hasRetrievedReferences
        - hasSearch
        - knowledgeBaseDocumentId
        - knowledgeBaseDocumentVariationId
        - knowledgeBaseDocumentVersionId
        - knowledgeBaseId
        - knowledgeSettingId
        - languageCode
        - mediaType
        - messageType
        - presentedDocumentsCount
        - queryType
        - queryTypeV3
        - queueId
        - searchId
        - searchQuery
        - selfServed
        - sessionId
        - surfacingMethod
        - userId
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension predicates
        $ref: '#/definitions/NumericRange'
  CaseManagementAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
        x-genesys-entity-type:
          value: INTERVAL
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - associationType
          - caseId
          - caseplanId
          - conversationId
          - customerIntentId
          - divisionId
          - ownerId
          - priority
          - stageId
          - status
          - stepId
          - workitemId
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/CaseManagementAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nCaseAssociationsCreated
          - nCasesDeleted
          - nCasesOpened
          - nCasesOverSla
          - nCasesPurged
          - nCasesStatusChanged
          - nCasesTerminated
          - oCasesServiceLevel
          - tCasesResolved
          - tCasesStatus
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/CaseManagementAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
  RoutingActivityMetricValue:
    type: object
    properties:
      metric:
        type: string
        description: Metric
        enum:
        - oActiveUsers
        - oMemberUsers
        - oOffQueueUsers
        - oOnQueueUsers
        - oUserPresences
        - oUserRoutingStatuses
      qualifier:
        type: string
        description: Metric qualifier
      secondaryQualifier:
        type: string
        description: Secondary metric qualifier
      entityIds:
        type: array
        description: Entity ids for matching entities if details were requested
        uniqueItems: true
        items:
          type: string
      count:
        type: integer
        format: int32
        description: Metric count
  JourneyAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
        x-genesys-entity-type:
          value: INTERVAL
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - containsAllCondition
          - containsAnyCondition
          - endsWithCondition
          - equalCondition
          - journeyActionId
          - journeyActionMapId
          - journeyActionMapVersion
          - journeyActionMediaType
          - journeyActionTargetId
          - journeyActionTemplateId
          - journeyBlockingActionMapId
          - journeyBlockingEmergencyScheduleGroupId
          - journeyBlockingReason
          - journeyBlockingScheduleGroupId
          - journeyDeviceCategory
          - journeyDeviceType
          - journeyFrequencyCapReason
          - journeyIpGeolocationCountry
          - journeyOutcomeId
          - journeySegmentAssignmentState
          - journeySegmentId
          - journeySessionId
          - journeySessionSegmentId
          - journeySessionType
          - notContainsAllCondition
          - notContainsAnyCondition
          - notEqualCondition
          - startsWithCondition
          - touchpointActionMapId
          - touchpointAgentId
          - touchpointAttributionScope
          - touchpointChannelMessageType
          - touchpointChannelPlatform
          - touchpointChannelType
          - touchpointConversationId
          - touchpointInteractionType
          - touchpointQueueId
          - touchpointRequestedRouting
          - touchpointUsedRouting
          - touchpointWrapupCode
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/JourneyAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nDistinctJourneyActions
          - nDistinctJourneySessions
          - nJourneyActionsBlocked
          - nJourneyOutcomesAchieved
          - nJourneyOutcomesAttributed
          - nJourneySegmentsAssigned
          - nJourneySessions
          - nWebActionsAbandoned
          - nWebActionsAccepted
          - nWebActionsEngaged
          - nWebActionsErrored
          - nWebActionsFrequencyCapReached
          - nWebActionsIgnored
          - nWebActionsOffered
          - nWebActionsOfferedOutsideSchedule
          - nWebActionsQualified
          - nWebActionsQualifiedOutsideSchedule
          - nWebActionsRejected
          - nWebActionsStarted
          - nWebActionsTimedout
          - oJourneyOutcomeTouchpointValue
          - oJourneyOutcomeValue
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/JourneyAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
  FlowObservationQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/FlowObservationQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/FlowObservationQueryPredicate'
  Detail:
    type: object
    properties:
      errorCode:
        type: string
      fieldName:
        type: string
      entityId:
        type: string
      entityName:
        type: string
  CaseManagementAggregateQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - associationType
        - caseId
        - caseplanId
        - conversationId
        - customerIntentId
        - divisionId
        - ownerId
        - priority
        - stageId
        - status
        - stepId
        - workitemId
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension predicates
        $ref: '#/definitions/NumericRange'
  TaskManagementAggregateDataContainer:
    type: object
    properties:
      group:
        type: object
        description: A mapping from dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        items:
          $ref: '#/definitions/StatisticalResponse'
  TaskManagementObservationMetricStats:
    type: object
    properties:
      count:
        type: integer
        format: int32
        description: The observed value for this metric
      max:
        type: integer
        format: int64
        description: The maximum observed value for this metric. Used for `oWorkitemOldestUnassigned` and  `oWorkitemOldestAssigned`
  SurveyAggregateQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/SurveyAggregateQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/SurveyAggregateQueryPredicate'
  FlowAggregationView:
    type: object
    required:
    - function
    - name
    - target
    properties:
      target:
        type: string
        description: Target metric name
        enum:
        - nFlow
        - nFlowMilestone
        - nFlowOutcome
        - nFlowOutcomeFailed
        - oFlowMilestone
        - tFlow
        - tFlowDisconnect
        - tFlowExit
        - tFlowOutcome
      name:
        type: string
        description: A unique name for this view. Must be distinct from other views and built-in metric names.
      function:
        type: string
        description: Type of view you wish to create
        enum:
        - rangeBound
      range:
        description: Range of numbers for slicing up data
        $ref: '#/definitions/AggregationRange'
  ReportingTurnsResponse:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/ReportingTurn'
      nextUri:
        type: string
      selfUri:
        type: string
      previousUri:
        type: string
  FlowExecutionAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/FlowExecutionAggregateDataContainer'
  ConversationDetailQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/ConversationDetailQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/ConversationDetailQueryPredicate'
  ConversationProperties:
    type: object
    properties:
      isWaiting:
        type: boolean
        description: Indicates filtering for waiting
      isActive:
        type: boolean
        description: Indicates filtering for active
      isAcd:
        type: boolean
        description: Indicates filtering for Acd
      isPreferred:
        type: boolean
        description: Indicates filtering for Preferred Agent Routing
      isScreenshare:
        type: boolean
        description: Indicates filtering for screenshare
      isCobrowse:
        type: boolean
        description: Indicates filtering for Cobrowse
      isVoicemail:
        type: boolean
        description: Indicates filtering for Voice mail
      isFlagged:
        type: boolean
        description: Indicates filtering for flagged
      isMonitored:
        type: boolean
        description: Indicates filtering for monitored
      isScreenMonitored:
        type: boolean
        description: 'Deprecated: Use screenMonitored'
      filterWrapUpNotes:
        type: boolean
        description: Indicates filtering for WrapUpNotes
      matchAll:
        type: boolean
        description: Indicates comparison operation, TRUE indicates filters will use AND logic, FALSE indicates OR logic
  CaseManagementAggregateQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/CaseManagementAggregateQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/CaseManagementAggregateQueryPredicate'
  TaskManagementAggregateQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/TaskManagementAggregateQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/TaskManagementAggregateQueryPredicate'
  ResolutionAggregateQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - conversationId
        - externalContactId
        - mediaType
        - queueId
        - requestedRouting
        - usedRouting
        - userId
        - wrapUpDate
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension predicates
        $ref: '#/definitions/NumericRange'
  ActionAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
        x-genesys-entity-type:
          value: INTERVAL
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - actionCategory
          - actionId
          - actionName
          - correlationId
          - errorType
          - integrationId
          - integrationName
          - responseStatus
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/ActionAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - tTotalExecution
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/ActionAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
  Limit:
    type: object
    properties:
      key:
        type: string
      namespace:
        type: string
        enum:
        - web.deployments
        - web.messaging
        - agent.assistant
        - agentic.virtual.agents
        - analytics.agents
        - analytics.alerting
        - analytics.data.extraction
        - analytics
        - analytics.realtime
        - analytics.reporting.settings
        - anomaly.detection
        - architect
        - audiohook
        - audiohook.monitor
        - audit
        - auth.api
        - authorization
        - automation.testing
        - bots
        - bots.voice
        - business.rules
        - callback
        - case.management
        - cobrowse
        - content.management
        - conversation
        - copilot
        - dataactions
        - datatables
        - directory
        - dsar
        - email
        - employee.engagement
        - event.orchestration
        - external.contacts
        - external.events.data.ingestion
        - gamification
        - gcv
        - gdpr
        - groups
        - guides
        - historical.adherence
        - infrastructureascode
        - integrations
        - intent.miner
        - internal.messaging
        - journey
        - knowledge
        - language.understanding
        - learning
        - limit.registry
        - marketplace
        - mcp.analytics.aggregates
        - mcp
        - media.communications
        - messaging
        - micro.frontend
        - multi.org
        - notifications
        - onboarding
        - outbound
        - platform.api
        - predictive.routing
        - presence
        - quality
        - recording
        - response.management
        - routing
        - scim
        - screen.monitoring
        - search
        - secondary.automation.testing
        - skills
        - social.media
        - speech.and.text.analytics
        - speech.integration
        - supportability
        - task.management
        - telephony.configuration
        - usage
        - users
        - users.rules
        - voice.transcription
        - webchat
        - webhooks
        - workforce.management.adherence
        - workforce.management.agent.availability
        - workforce.management.forecast
        - workforce.management
        - workforce.management.scheduling.preferences
        - workforce.management.self.schedule
        - workforce.management.shift.trading
        - system
      value:
        type: integer
        format: int64
  BotAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
        x-genesys-entity-type:
          value: INTERVAL
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - askActionId
          - askActionResult
          - askActionType
          - botFinalIntent
          - botFlowSubType
          - botFlowType
          - botId
          - botIntent
          - botName
          - botProduct
          - botProvider
          - botRecognitionFailureReason
          - botResult
          - botSessionId
          - botSlot
          - botSlotMechanism
          - botVersion
          - conversationId
          - externalContactId
          - intermediateIntentName
          - knowledgeBaseId
          - languageCode
          - lastActionId
          - lastInputActionId
          - mediaType
          - messageType
          - previewMode
          - selfServed
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/BotAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nBotSessionTurns
          - nBotSessions
          - oBotIntent
          - oBotSessionCollection
          - oBotSessionCollectionSelfServed
          - oBotSessionQuery
          - oBotSessionQuerySelfServed
          - oBotSessionTurn
          - oBotSlot
          - tBotDisconnect
          - tBotExit
          - tBotRecognitionFailure
          - tBotSession
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/BotAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
      queryType:
        type: string
        description: Query type to use. Use groupBy for all matching results, and topN/bottomN for N results ordered by the sortMetric. Default is groupBy.
        enum:
        - bottomN
        - groupBy
        - topN
      sortMetric:
        description: Required when requesting multiple metrics. Only applicable for topN/bottomN query type.
        $ref: '#/definitions/BotAggregationSort'
      limit:
        type: integer
        format: int32
        description: How many results you want in an ordered list. Only applicable for topN/bottomN query type.
  RateLimitAggregateQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/RateLimitAggregateQueryPredicate'
  SocialKeyword:
    type: object
    properties:
      includes:
        type: array
        description: List of keywords that must be included
        items:
          type: string
      excludes:
        type: array
        description: List of keywords that must be excluded
        items:
          type: string
  UserAggregateQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/UserAggregateQueryPredicate'
  KnowledgeAsyncAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/KnowledgeAggregateDataContainer'
      cursor:
        type: string
        description: Cursor token to retrieve next page
  UserActivityQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - organizationPresenceId
        - presenceDate
        - queueId
        - queueMembershipStatus
        - routingStatus
        - routingStatusDate
        - systemPresence
        - teamId
        - userId
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
  FlowObservationQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/FlowObservationDataContainer'
  EvaluationAggregationView:
    type: object
    required:
    - function
    - name
    - target
    properties:
      target:
        type: string
        description: Target metric name
        enum:
        - nEvaluations
        - nEvaluationsDeleted
        - nEvaluationsRescored
        - oTotalCriticalScore
        - oTotalScore
      name:
        type: string
        description: A unique name for this view. Must be distinct from other views and built-in metric names.
      function:
        type: string
        description: Type of view you wish to create
        enum:
        - rangeBound
      range:
        description: Range of numbers for slicing up data
        $ref: '#/definitions/AggregationRange'
  KnowledgeAggregationSort:
    type: object
    required:
    - function
    - name
    properties:
      name:
        type: string
        description: Name of the metric used for sorting values.
        enum:
        - nDistinctKnowledgeSessions
        - nKnowledgeDocumentCopied
        - nKnowledgeDocumentFeedback
        - nKnowledgeDocumentPresented
        - nKnowledgeDocumentSurfaced
        - nKnowledgeDocumentViewed
        - nKnowledgeSearch
        - nKnowledgeSearchAnswered
        - nKnowledgeSearchFeedback
        - nKnowledgeSearchUnanswered
        - nKnowledgeSessions
        - nKnowledgeV3Search
        - oKnowledgeDocumentQuery
        - oKnowledgeDocumentQuerySelfServed
        - oKnowledgeSearch
      function:
        type: string
        description: Aggregation function used for the sort metric.
        enum:
        - average
        - count
        - max
        - min
        - sum
  CaseManagementAggregateQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/CaseManagementAggregateQueryPredicate'
  PresenceDetailQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/PresenceDetailQueryPredicate'
  ConversationActivityQueryMetric:
    type: object
    required:
    - metric
    properties:
      metric:
        type: string
        description: The requested metric
        enum:
        - oAlerting
        - oInteracting
        - oLongestInteracting
        - oLongestWaiting
        - oWaiting
      details:
        type: boolean
        description: Flag for including observation details for this metric in the response
  SurveyDetailQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/SurveyDetailQueryPredicate'
  UserDetailsQuery:
    type: object
    required:
    - interval
    properties:
      interval:
        type: string
        format: interval
        description: 'Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
      userFilters:
        type: array
        description: Filters that target the users to retrieve data for
        items:
          $ref: '#/definitions/UserDetailQueryFilter'
      presenceFilters:
        type: array
        description: Filters that target system and organization presence-level data
        items:
          $ref: '#/definitions/PresenceDetailQueryFilter'
      routingStatusFilters:
        type: array
        description: Filters that target agent routing status-level data
        items:
          $ref: '#/definitions/RoutingStatusDetailQueryFilter'
      order:
        type: string
        description: Sort the result set in ascending/descending order. Default is ascending
        enum:
        - asc
        - desc
        - unordered
      presenceAggregations:
        type: array
        description: Include faceted search and aggregate roll-ups of presence data in your search results. This does not function as a filter, but rather, summary data about the presence results matching your filters
        items:
          $ref: '#/definitions/AnalyticsQueryAggregation'
      routingStatusAggregations:
        type: array
        description: Include faceted search and aggregate roll-ups of agent routing status data in your search results. This does not function as a filter, but rather, summary data about the agent routing status results matching your filters
        items:
          $ref: '#/definitions/AnalyticsQueryAggregation'
      paging:
        description: Page size and number to control iterating through large result sets. Default page size is 25
        $ref: '#/definitions/PagingSpec'
  RoutingStatusDetailQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - routingStatus
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension predicates
        $ref: '#/definitions/NumericRange'
  AnalyticsAgentStateAgentResponse:
    type: object
    properties:
      userId:
        type: string
        description: User Id - only returned if division is covered by agentStateNames permission
      divisionId:
        type: string
        description: Division Id
      userName:
        type: string
        description: User name - only returned if division is covered by agentStateNames permission
      managerId:
        type: string
        description: The user that this user reports to
      sessionCount:
        type: integer
        format: int32
        description: The count of sessions
      sessions:
        type: array
        description: List of sessions
        items:
          $ref: '#/definitions/AnalyticsAgentStateAgentSessionResult'
      systemPresence:
        type: string
        description: The user's system presence
        enum:
        - UNKNOWN
        - AVAILABLE
        - AWAY
        - BUSY
        - OFFLINE
        - IDLE
        - ON_QUEUE
        - MEAL
        - TRAINING
        - MEETING
        - BREAK
      organizationPresenceId:
        type: string
        description: The identifier for the user's organization presence
      presenceDate:
        type: string
        format: date-time
        description: 'The timestamp for when the user''s presence began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      routingStatus:
        type: string
        description: The user's routing status
        enum:
        - UNKNOWN
        - OFF_QUEUE
        - IDLE
        - INTERACTING
        - NOT_RESPONDING
        - COMMUNICATING
      routingStatusDate:
        type: string
        format: date-time
        description: 'The timestamp for when the user''s routing status began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      isOutOfOffice:
        type: boolean
        description: Whether the user is out of office
  FlowAggregateQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/FlowAggregateQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/FlowAggregateQueryPredicate'
  SummaryAggregateDataContainer:
    type: object
    properties:
      group:
        type: object
        description: A mapping from dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        items:
          $ref: '#/definitions/StatisticalResponse'
  RoutingActivityQueryMetric:
    type: object
    required:
    - metric
    properties:
      metric:
        type: string
        description: The requested metric
        enum:
        - oActiveUsers
        - oMemberUsers
        - oOffQueueUsers
        - oOnQueueUsers
        - oUserPresences
        - oUserRoutingStatuses
      details:
        type: boolean
        description: Flag for including observation details for this metric in the response
  DashboardUser:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      dashboardCount:
        type: integer
        format: int32
        description: The count of dashboards for the user
      publicDashboardCount:
        type: integer
        format: int32
        description: The count of public dashboards for the user
      state:
        type: string
        description: The state of the user
        enum:
        - active
        - inactive
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  RoutingActivityQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - organizationPresenceId
        - presenceDate
        - queueId
        - queueMembershipStatus
        - routingStatus
        - routingStatusDate
        - systemPresence
        - teamId
        - userId
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
  PresenceDetailQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - organizationPresenceId
        - systemPresence
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension predicates
        $ref: '#/definitions/NumericRange'
  AgentCopilotAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
        x-genesys-entity-type:
          value: INTERVAL
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - agentAssistantId
          - cannedResponseId
          - cannedResponseLibraryId
          - chunkCount
          - conversationId
          - engagementType
          - externalContactId
          - feedbackRating
          - hasAnswerHighlight
          - hasGeneratedAnswer
          - knowledgeBaseDocumentId
          - knowledgeBaseDocumentVersionId
          - knowledgeSettingId
          - mediaType
          - messageId
          - queueId
          - scriptId
          - scriptPageId
          - searchId
          - state
          - suggestionId
          - suggestionType
          - triggerType
          - userId
          - utteranceId
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/AgentCopilotAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nCannedResponseSuggestions
          - nDistinctConversations
          - nDistinctSuggestions
          - nKnowledgeAnswerSuggestions
          - nKnowledgeArticleSuggestions
          - nKnowledgeSearchSuggestions
          - nScriptSuggestions
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/AgentCopilotAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
      queryType:
        type: string
        description: Query type to use. Use groupBy for all matching results, and topN/bottomN for N results ordered by the sortMetric. Default is groupBy.
        enum:
        - bottomN
        - groupBy
        - topN
      sortMetric:
        description: Required when requesting multiple metrics. Only applicable for topN/bottomN query type.
        $ref: '#/definitions/AgentCopilotAggregationSort'
      limit:
        type: integer
        format: int32
        description: How many results you want in an ordered list. Only applicable for topN/bottomN query type.
  TaskManagementAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
        x-genesys-entity-type:
          value: INTERVAL
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - assigneeId
          - caseId
          - divisionId
          - externalTag
          - queueId
          - reporterId
          - requestedLanguageId
          - requestedRouting
          - requestedRoutingSkillId
          - statusCategory
          - statusId
          - typeId
          - usedRouting
          - userId
          - workbinId
          - workitemId
          - wrapUpCode
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/TaskManagementAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nWorkitemsAcdCancelled
          - nWorkitemsAcdExpired
          - nWorkitemsAcdStarted
          - nWorkitemsAgentTransferred
          - nWorkitemsCreated
          - nWorkitemsDeclined
          - nWorkitemsDeleted
          - nWorkitemsDisconnected
          - nWorkitemsOffered
          - nWorkitemsOverSla
          - nWorkitemsPurged
          - nWorkitemsQueueTransferred
          - nWorkitemsStatusChanged
          - nWorkitemsTerminated
          - nWorkitemsTimedout
          - nWorkitemsTransferred
          - nWorkitemsWrapupAdded
          - nWorkitemsWrapupRemoved
          - oWorkitemsServiceLevel
          - tWorkitemsAgentFocusComplete
          - tWorkitemsAlert
          - tWorkitemsAnswered
          - tWorkitemsDirectAnswered
          - tWorkitemsFocus
          - tWorkitemsFocusComplete
          - tWorkitemsHandled
          - tWorkitemsHeld
          - tWorkitemsHeldComplete
          - tWorkitemsNotResponding
          - tWorkitemsParked
          - tWorkitemsQueueAnswered
          - tWorkitemsStatus
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/TaskManagementAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
  CaseManagementAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/CaseManagementAggregateDataContainer'
  SurveyAggregateQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - conversationId
        - divisionId
        - externalContactId
        - mediaType
        - queueId
        - requestedLanguageId
        - requestedRoutingSkillId
        - surveyAnswerId
        - surveyCreatedDate
        - surveyErrorReason
        - surveyFormContextId
        - surveyFormId
        - surveyFormName
        - surveyId
        - surveyPartialResponse
        - surveyPreviousStatus
        - surveyPromoterScore
        - surveyQuestionGroupId
        - surveyQuestionId
        - surveyStatus
        - surveyType
        - teamId
        - userId
        - wrapUpCode
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension predicates
        $ref: '#/definitions/NumericRange'
  DashboardConfiguration:
    type: object
    required:
    - dateCreated
    - dateDeleted
    - dateModified
    - name
    - widgets
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
        description: The name of dashboard configuration.
      rows:
        type: integer
        description: The count of rows for the specific dashboard configuration.
      columns:
        type: integer
        description: The count of columns for the specific dashboard.
      widgets:
        type: array
        description: List of widgets for dashboard configuration.
        items:
          $ref: '#/definitions/Widget'
      favorite:
        type: boolean
        description: The flag indicates if the dashboard is favorited by the user
      publicDashboard:
        type: boolean
        description: The flag to indicate if the dashboard is published by an user
      restricted:
        type: boolean
        description: The flag to indicate if the dashboard has any restricted data for that user
        readOnly: true
      layoutType:
        type: string
        description: The layout type of the dashboard
        enum:
        - Grid
        - Flow
      dateCreated:
        type: string
        format: date-time
        description: 'The created date of the dashboard. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      dateModified:
        type: string
        format: date-time
        description: 'The last modified date of the dashboard. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      dateDeleted:
        type: string
        format: date-time
        description: 'The deleted date of the dashboard. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      createdBy:
        description: The id of user who created the dashboard
        readOnly: true
        $ref: '#/definitions/AddressableEntityRef'
      shared:
        type: boolean
        description: The flag to indicate if the dashboard is shared
      dashboardsSharedWith:
        description: The list of users and teams the dashboard is shared with
        $ref: '#/definitions/DashboardsSharedWith'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  ReportingTurnKnowledgeSearchEvent:
    type: object
    properties:
      searchId:
        type: string
        description: The ID of this knowledge search.
      knowledgeBaseId:
        type: string
        description: The Knowledge Base ID that the captured knowledge data relates to.
      documents:
        type: array
        description: The list of search documents that the feedback applies to.
        items:
          $ref: '#/definitions/ReportingTurnKnowledgeDocument'
      searchQuery:
        type: string
        description: The search query that was used to search the Knowledge Base documents for a matching question.
      answerDocumentId:
        type: string
        description: The document ID of the search answer.
  ActionAggregateQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - actionCategory
        - actionId
        - actionName
        - correlationId
        - errorType
        - integrationId
        - integrationName
        - responseStatus
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension predicates
        $ref: '#/definitions/NumericRange'
  FlowObservationQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - flowId
        - mediaType
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension predicates
        $ref: '#/definitions/NumericRange'
  SummaryAggregationView:
    type: object
    required:
    - function
    - name
    - target
    properties:
      target:
        type: string
        description: Target metric name
        enum:
        - nConversationSummaries
        - nConversationSummaryEngagements
        - tConversationSummary
      name:
        type: string
        description: A unique name for this view. Must be distinct from other views and built-in metric names.
      function:
        type: string
        description: Type of view you wish to create
        enum:
        - rangeBound
      range:
        description: Range of numbers for slicing up data
        $ref: '#/definitions/AggregationRange'
  ReportingTurnIntentSlot:
    type: object
    properties:
      name:
        type: string
        description: The name of the slot.
      value:
        type: string
        description: The value of the slot.
      type:
        type: string
        description: The NLU entity type of the slot (either builtin or user defined)
      confidence:
        type: number
        format: double
        description: The confidence score this slot received during detection.
  AnalyticsConversationQueryResponse:
    type: object
    properties:
      conversations:
        type: array
        items:
          $ref: '#/definitions/AnalyticsConversationWithoutAttributes'
      aggregations:
        type: array
        items:
          $ref: '#/definitions/AggregationResult'
      totalHits:
        type: integer
        format: int32
  TeamActivityMetricValue:
    type: object
    properties:
      metric:
        type: string
        description: Metric
        enum:
        - oTeamOffQueueUsers
        - oTeamOnQueueUsers
        - oTeamPresences
        - oTeamRoutingStatuses
      qualifier:
        type: string
        description: Metric qualifier
      secondaryQualifier:
        type: string
        description: Secondary metric qualifier
      entityIds:
        type: array
        description: Entity ids for matching entities if details were requested
        uniqueItems: true
        items:
          type: string
      count:
        type: integer
        format: int32
        description: Metric count
  ConversationAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/ConversationAggregateDataContainer'
  RoutingActivityData:
    type: object
    properties:
      group:
        type: object
        description: A mapping from grouping dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        description: Data for metrics
        items:
          $ref: '#/definitions/RoutingActivityMetricValue'
      truncated:
        type: boolean
        description: Flag for a truncated list of entities. If truncated, the first half of the list of entities will contain the oldest entities and the second half the newest entities.
      entities:
        type: array
        description: Details for active entities
        items:
          $ref: '#/definitions/RoutingActivityEntityData'
  ConversationDetailQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - accessAttribute
        - conversationEnd
        - conversationId
        - conversationInitiator
        - conversationStart
        - customerParticipation
        - divisionId
        - externalTag
        - mediaStatsMinConversationMos
        - originatingDirection
        - originatingSocialMediaPublic
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      metric:
        type: string
        description: Left hand side for metric predicates
        enum:
        - nBlindTransferred
        - nBotInteractions
        - nCallbackAttempts
        - nCallbackOverSla
        - nCallbackScheduled
        - nCfcOffered
        - nCobrowseSessions
        - nConnected
        - nConsult
        - nConsultTransferred
        - nConversations
        - nError
        - nFlow
        - nFlowMilestone
        - nFlowOutcome
        - nFlowOutcomeFailed
        - nOffered
        - nOutbound
        - nOutboundAbandoned
        - nOutboundAttempted
        - nOutboundConnected
        - nOverSla
        - nStateTransitionError
        - nTakeover
        - nTransferred
        - oAudioMessageCount
        - oExternalAudioMessageCount
        - oExternalMediaCount
        - oFlowMilestone
        - oMediaCount
        - oMessageCount
        - oMessageSegmentCount
        - oMessageTurn
        - oSkillExpressionApplications
        - tAbandon
        - tAcd
        - tActiveCallback
        - tActiveCallbackComplete
        - tAcw
        - tAgentResponseTime
        - tAgentVideoConnected
        - tAlert
        - tAnswered
        - tAverageAgentResponseTime
        - tAverageCustomerResponseTime
        - tBarging
        - tCallbackAbandon
        - tCallbackConnect
        - tCallbackNotReached
        - tCallbackVirtualWait
        - tCfcAbandon
        - tCfcAcd
        - tCfcAnswered
        - tCfcFlowOut
        - tCoaching
        - tCoachingComplete
        - tConnected
        - tContacting
        - tConversationDuration
        - tDialing
        - tFirstConnect
        - tFirstDial
        - tFirstEngagement
        - tFirstResponse
        - tFlow
        - tFlowDisconnect
        - tFlowExit
        - tFlowOut
        - tFlowOutcome
        - tHandle
        - tHeld
        - tHeldComplete
        - tIvr
        - tMonitoring
        - tMonitoringComplete
        - tNotResponding
        - tPark
        - tParkComplete
        - tScreenMonitoring
        - tShortAbandon
        - tSnippetRecord
        - tTalk
        - tTalkComplete
        - tTransmitting
        - tUserResponseTime
        - tVoicemail
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension or metric predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension or metric predicates
        $ref: '#/definitions/NumericRange'
  StatisticalResponse:
    type: object
    properties:
      interval:
        type: string
      metrics:
        type: array
        items:
          $ref: '#/definitions/AggregateMetricData'
      views:
        type: array
        items:
          $ref: '#/definitions/AggregateViewData'
  AggregateViewData:
    type: object
    properties:
      name:
        type: string
      stats:
        $ref: '#/definitions/StatisticalSummary'
  ConversationAsyncAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/ConversationAggregateDataContainer'
      cursor:
        type: string
        description: Cursor token to retrieve next page
  RoutingActivityQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/RoutingActivityQueryPredicate'
  FlowActivityQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - activeRouting
        - addressFrom
        - addressTo
        - agentScore
        - ani
        - conversationId
        - convertedFrom
        - convertedTo
        - direction
        - dnis
        - flowId
        - flowType
        - mediaType
        - participantName
        - queueId
        - requestedLanguageId
        - requestedRouting
        - requestedRoutingSkillId
        - routingPriority
        - scoredAgentId
        - sessionId
        - teamId
        - usedRouting
        - userId
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
  AgentStateAgentQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: Describes a <dimension> = <value> filter used to perform matching
        items:
          $ref: '#/definitions/AgentStateAgentQueryPredicate'
  ReportingExportJobResponse:
    type: object
    required:
    - createdDateTime
    - exportFormat
    - filter
    - interval
    - locale
    - modifiedDateTime
    - percentageComplete
    - period
    - read
    - runId
    - status
    - timeZone
    - viewType
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      runId:
        type: string
        description: The unique run id of the export schedule execute
      status:
        type: string
        description: The current status of the export request
        enum:
        - SUBMITTED
        - RUNNING
        - CANCELLING
        - CANCELLED
        - COMPLETED
        - COMPLETED_WITH_PARTIAL_RESULTS
        - FAILED
      timeZone:
        type: string
        description: 'The requested timezone of the exported data. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      exportFormat:
        type: string
        description: The requested format of the exported data
        enum:
        - CSV
        - PDF
      interval:
        type: string
        format: interval
        description: 'The time period used to limit the the exported data. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
      downloadUrl:
        type: string
        description: The url to download the request if it's status is completed
      viewType:
        type: string
        description: The type of view export job to be created
        enum:
        - QUEUE_PERFORMANCE_SUMMARY_VIEW
        - QUEUE_PERFORMANCE_DETAIL_VIEW
        - INTERACTION_SEARCH_VIEW
        - AGENT_PERFORMANCE_SUMMARY_VIEW
        - AGENT_PERFORMANCE_DETAIL_VIEW
        - AGENT_STATUS_SUMMARY_VIEW
        - AGENT_STATUS_DETAIL_VIEW
        - AGENT_EVALUATION_SUMMARY_VIEW
        - AGENT_EVALUATION_DETAIL_VIEW
        - AGENT_QUEUE_DETAIL_VIEW
        - AGENT_INTERACTION_DETAIL_VIEW
        - ABANDON_INSIGHTS_VIEW
        - SKILLS_PERFORMANCE_VIEW
        - SURVEY_FORM_PERFORMANCE_SUMMARY_VIEW
        - SURVEY_FORM_PERFORMANCE_DETAIL_VIEW
        - DNIS_PERFORMANCE_SUMMARY_VIEW
        - DNIS_PERFORMANCE_DETAIL_VIEW
        - WRAP_UP_PERFORMANCE_SUMMARY_VIEW
        - AGENT_WRAP_UP_PERFORMANCE_DETAIL_VIEW
        - QUEUE_ACTIVITY_SUMMARY_VIEW
        - QUEUE_ACTIVITY_DETAIL_VIEW
        - AGENT_QUEUE_ACTIVITY_SUMMARY_VIEW
        - QUEUE_AGENT_DETAIL_VIEW
        - QUEUE_INTERACTION_DETAIL_VIEW
        - AGENT_SCHEDULE_DETAIL_VIEW
        - IVR_PERFORMANCE_SUMMARY_VIEW
        - IVR_PERFORMANCE_DETAIL_VIEW
        - ANSWER_INSIGHTS_VIEW
        - HANDLE_INSIGHTS_VIEW
        - TALK_INSIGHTS_VIEW
        - HOLD_INSIGHTS_VIEW
        - ACW_INSIGHTS_VIEW
        - WAIT_INSIGHTS_VIEW
        - AGENT_WRAP_UP_PERFORMANCE_INTERVAL_DETAIL_VIEW
        - FLOW_OUTCOME_SUMMARY_VIEW
        - FLOW_OUTCOME_PERFORMANCE_DETAIL_VIEW
        - FLOW_OUTCOME_PERFORMANCE_INTERVAL_DETAIL_VIEW
        - FLOW_DESTINATION_SUMMARY_VIEW
        - FLOW_DESTINATION_DETAIL_VIEW
        - API_USAGE_VIEW
        - SCHEDULED_CALLBACKS_VIEW
        - CONTENT_SEARCH_VIEW
        - LANDING_PAGE
        - DASHBOARD_SUMMARY
        - DASHBOARD_DETAIL
        - DASHBOARD_USERS
        - DASHBOARD_USERS_DETAIL
        - JOURNEY_ACTION_MAP_SUMMARY_VIEW
        - JOURNEY_OUTCOME_SUMMARY_VIEW
        - JOURNEY_SEGMENT_SUMMARY_VIEW
        - AGENT_DEVELOPMENT_DETAIL_VIEW
        - AGENT_DEVELOPMENT_DETAIL_ME_VIEW
        - AGENT_DEVELOPMENT_SUMMARY_VIEW
        - AGENT_PERFORMANCE_ME_VIEW
        - AGENT_STATUS_ME_VIEW
        - AGENT_EVALUATION_ME_VIEW
        - AGENT_SCORECARD_VIEW
        - AGENT_SCORECARD_ME_VIEW
        - AGENT_GAMIFICATION_LEADERSHIP_VIEW
        - AGENT_SCHEDULE_ME_VIEW
        - BOT_PERFORMANCE_SUMMARY_VIEW
        - BOT_PERFORMANCE_DETAIL_VIEW
        - SCHEDULED_EXPORTS_VIEW
        - TOPIC_TREND_SUMMARY_VIEW
        - TOPIC_TREND_DETAIL_VIEW
        - ACTION_MAP_BLOCKED_CONSTRAINTS_DETAIL_VIEW
        - ACTION_MAP_BLOCKED_CONSTRAINTS_INTERVAL_DETAIL_VIEW
        - FLOW_MILESTONE_PERFORMANCE_DETAIL_VIEW
        - FLOW_MILESTONE_PERFORMANCE_INTERVAL_DETAIL_VIEW
        - AGENT_TOPIC_SUMMARY_VIEW
        - AGENT_TOPIC_DETAIL_VIEW
        - QUEUE_TOPIC_SUMMARY_VIEW
        - QUEUE_TOPIC_DETAIL_VIEW
        - FLOW_TOPIC_SUMMARY_VIEW
        - FLOW_TOPIC_DETAIL_VIEW
        - AGENT_INTERACTIONS_ME_VIEW
        - ALERT_RULES_VIEW
        - CONFIGURE_ALERT_RULE_VIEW
        - PREDICTIVE_ROUTING_VIEW
        - PREDICTIVE_ROUTING_QUEUE_OVERVIEW
        - PREDICTIVE_ROUTING_MODEL_VIEW
        - PREDICTIVE_ROUTING_IMPACT_VIEW
        - DATA_ACTIONS_PERFORMANCE_SUMMARY_VIEW
        - DATA_ACTIONS_PERFORMANCE_DETAIL_VIEW
        - AGENT_TIMELINE_SUMMARY_VIEW
        - AGENT_TIMELINE_DETAIL_VIEW
        - AGENT_LOGIN_LOGOUT_SUMMARY_VIEW
        - AGENT_LOGIN_LOGOUT_DETAIL_VIEW
        - CAMPAIGN_PERFORMANCE_SUMMARY_VIEW
        - CAMPAIGN_PERFORMANCE_DETAIL_VIEW
        - KNOWLEDGE_PERFORMANCE_VIEW
        - AGENT_SCORECARD_INSIGHTS_SUMMARY_VIEW
        - AGENT_SCORECARD_INSIGHTS_DETAIL_VIEW
        - QUEUE_WRAPUP_DETAIL_VIEW
        - INTERACTION_DETAIL_VIEW
        - CAMPAIGN_INTERACTION_DETAIL_VIEW
        - CAMPAIGN_ATTEMPT_DETAIL_VIEW
        - WORKITEM_PERFORMANCE_SUMMARY_VIEW
        - AGENT_ASSIST_PERFORMANCE_VIEW
        - CONTACT_CENTER_PERFORMANCE_VIEW
        - QUEUE_ROUTING_PERFORMANCE_VIEW
        - AGENT_WORKITEM_PERFORMANCE_SUMMARY_VIEW
        - AGENT_WORKITEM_PERFORMANCE_DETAIL_VIEW
        - QUEUE_WORKITEM_PERFORMANCE_SUMMARY_VIEW
        - QUEUE_WORKITEM_PERFORMANCE_DETAIL_VIEW
        - EMAIL_AGENT_PERFORMANCE_SUMMARY_VIEW
        - EMAIL_AGENT_PERFORMANCE_DETAIL_VIEW
        - MESSAGING_AGENT_PERFORMANCE_SUMMARY_VIEW
        - MESSAGING_AGENT_PERFORMANCE_DETAIL_VIEW
        - EMAIL_QUEUE_PERFORMANCE_SUMMARY_VIEW
        - EMAIL_QUEUE_PERFORMANCE_DETAIL_VIEW
        - MESSAGING_QUEUE_PERFORMANCE_SUMMARY_VIEW
        - MESSAGING_QUEUE_PERFORMANCE_DETAIL_VIEW
        - SOCIAL_LISTENING_VIEW
        - SOCIAL_LISTENING_POSTS_VIEW
        - AGENT_PERFORMANCE_TIMELINE_DETAIL_VIEW
        - DASHBOARD_SLIDESHOWS
        - DASHBOARD_SLIDESHOWS_DETAIL
        - AGENT_COPILOT_PERFORMANCE_VIEW
        - AGENT_ASSIGNED_EVALUATION_ME_VIEW
        - VIRTUAL_AGENT_PERFORMANCE_VIEW
        - CONTENT_EXPLORATION_VIEW
        - EVALUATION_PERFORMANCE_SUMMARY_VIEW
        - EVALUATION_PERFORMANCE_DETAIL_VIEW
        - EVALUATION_PERFORMANCE_QUESTION_GROUP_DETAIL_VIEW
        - EVALUATION_PERFORMANCE_QUESTION_DETAIL_VIEW
        - QUEUE_WORKITEM_ACTIVITY_SUMMARY_VIEW
        - QUEUE_WORKITEM_ACTIVITY_DETAIL_VIEW
        - DIGITAL_ADOPTION_VIEW
        - DIGITAL_INTENT_VIEW
        - DIGITAL_PERFORMANCE_VIEW
        - COPILOT_USAGE_VIEW
        - PREDICTIVE_ROUTING_THROUGHPUT_VIEW
        - QUEUE_SKILL_EXPRESSION_PERFORMANCE_VIEW
        - AGENTIC_VIRTUAL_AGENT_PERFORMANCE_VIEW
        - CALLBACK_QUEUE_PERFORMANCE_SUMMARY_VIEW
        - CALLBACK_QUEUE_PERFORMANCE_DETAIL_VIEW
      exportErrorMessagesType:
        type: string
        description: The error message in case the export request failed
        enum:
        - FAILED_CONVERTING_EXPORT_JOB
        - FAILED_NO_DATA_EXPORT_JOB_FOUND
        - FAILED_GETTING_DATA_FROM_SERVICE
        - FAILED_GENERATING_TEMP_FILE
        - FAILED_SAVING_FILE_TO_S3
        - FAILED_NOTIFYING_SKYWALKER_OF_DOWNLOAD
        - FAILED_BUILDING_DOWNLOAD_URL_FROM_SKYWALKER_RESPONSE
        - FAILED_CONVERTING_EXPORT_JOB_TO_QUEUE_PERFORMANCE_JOB
        - EXPORT_TYPE_NOT_IMPLEMENTED
        - REACHED_MAXIMUM_ATTEMPT_OF_RETRY
        - FAILED_LONG_RUNNING_EXPORT
        - TOO_MANY_REQUESTS_FROM_AN_ORGANIZATION
        - FAILED_AS_EXPORT_FILE_SIZE_IS_GREATER_THAN_10MB
        - NOT_AUTHORIZED_TO_VIEW_EXPORT
        - STATIC_LINK_EXPORT_FAILED
        - TOO_MANY_SEARCH_CRITERIA
        - SEARCH_CRITERIA_VALUES_EXCEED_LIMIT
        - EXPORT_EMAIL_FILE_SIZE_EXCEEDED_LIMIT
        - CIRCUIT_BREAKER_OPEN_FOR_VIEW_TYPE
        - BAD_REQUEST_SCHEDULED_RUN
      period:
        type: string
        description: 'The Period of the request in which to break down the intervals. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      filter:
        description: Filters to apply to create the view
        $ref: '#/definitions/ViewFilter'
      read:
        type: boolean
        description: Indicates if the request has been marked as read
      createdDateTime:
        type: string
        format: date-time
        description: 'The created date/time of the request. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      modifiedDateTime:
        type: string
        format: date-time
        description: 'The last modified date/time of the request. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      locale:
        type: string
        description: 'The locale use for localization of the exported data, i.e. en-us, es-mx  '
      percentageComplete:
        type: number
        format: double
        description: The percentage of the job that has completed processing
      hasFormatDurations:
        type: boolean
        description: Indicates if durations are formatted in hh:mm:ss format instead of ms
      hasSplitFilters:
        type: boolean
        description: Indicates if filters will be split in aggregate detail exports
      excludeEmptyRows:
        type: boolean
        description: Excludes empty rows from the exports
      hasSplitByMedia:
        type: boolean
        description: Indicates if media type will be split in aggregate detail exports
      hasSummaryRow:
        type: boolean
        description: Indicates if summary row needs to be present in exports
      csvDelimiter:
        type: string
        description: The user supplied csv delimiter string value either of type 'comma' or 'semicolon' permitted for the export request
        enum:
        - SEMICOLON
        - COMMA
      selectedColumns:
        type: array
        description: The list of ordered selected columns from the export view by the user
        items:
          $ref: '#/definitions/SelectedColumns'
      hasCustomParticipantAttributes:
        type: boolean
        description: Indicates if custom participant attributes will be exported
      recipientEmails:
        type: array
        description: The list of email recipients for the exports
        items:
          type: string
      emailStatuses:
        type: object
        description: The status of individual email addresses as a map
        additionalProperties:
          type: string
          enum:
          - Sent
          - Pending
          - Failed
      emailErrorDescription:
        type: string
        description: The optional error message in case the export fail to email
      includeDurationFormatInHeader:
        type: boolean
        description: Indicates whether to include selected duration format to the column headers
      durationFormat:
        type: string
        description: Indicates the duration format for the exports
        enum:
        - Seconds
        - Milliseconds
        - Hhmmss
        - Hms
      exportAllowedToRerun:
        type: boolean
        description: Indicates whether the export run is allowed to rerun
      chartColumns:
        type: array
        description: The list of columns for which chart is going to be displayed in export
        items:
          $ref: '#/definitions/ChartColumn'
      enabled:
        type: boolean
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  UserAggregateQueryResponse:
    type: object
    properties:
      systemToOrganizationMappings:
        type: object
        description: A mapping from system presence to a list of organization presence ids
        additionalProperties:
          type: array
          items:
            type: string
      results:
        type: array
        items:
          $ref: '#/definitions/UserAggregateDataContainer'
  AnalyticsConversationSegment:
    type: object
    properties:
      audioMuted:
        type: boolean
        description: Flag indicating if audio is muted or not (true/false)
      conference:
        type: boolean
        description: Indicates whether the segment was a conference
      destinationConversationId:
        type: string
        description: The unique identifier of a new conversation when a conversation is ended for a conference
      destinationSessionId:
        type: string
        description: The unique identifier of a new session when a session is ended for a conference
      disconnectType:
        type: string
        description: The session disconnect type
        enum:
        - client
        - conferenceTransfer
        - consultTransfer
        - dndEndpoint
        - dndTransfer
        - endpoint
        - error
        - forwardTransfer
        - inactivity
        - noAnswerTransfer
        - notAvailableTransfer
        - other
        - peer
        - sessionExpired
        - spam
        - system
        - takeover
        - timeout
        - transfer
        - transportFailure
        - uncallable
      errorCode:
        type: string
        description: A code corresponding to the error that occurred
      groupId:
        type: string
        description: Unique identifier for a Genesys Cloud group
      q850ResponseCodes:
        type: array
        description: Q.850 response code(s)
        items:
          type: integer
          format: int64
      queueId:
        type: string
        description: Queue identifier
      requestedLanguageId:
        type: string
        description: Unique identifier for the language requested for an interaction
      requestedRoutingSkillIds:
        type: array
        description: Unique identifier(s) for skill(s) requested for an interaction
        items:
          type: string
      requestedRoutingUserIds:
        type: array
        description: Unique identifier(s) for agent(s) requested for an interaction
        items:
          type: string
      segmentEnd:
        type: string
        format: date-time
        description: 'The end time of a segment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      segmentStart:
        type: string
        format: date-time
        description: 'The start time of a segment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      segmentType:
        type: string
        description: The activity that takes place in the segment, such as hold or interact
        enum:
        - alert
        - barging
        - callback
        - coaching
        - contacting
        - converting
        - delay
        - dialing
        - hold
        - interact
        - ivr
        - monitoring
        - parked
        - scheduled
        - screenmonitoring
        - sharing
        - system
        - transmitting
        - unknown
        - uploading
        - voicemail
        - wrapup
      sipResponseCodes:
        type: array
        description: SIP response code(s)
        items:
          type: integer
          format: int64
      sourceConversationId:
        type: string
        description: The unique identifier of the previous conversation when a new conversation is created for a conference
      sourceSessionId:
        type: string
        description: The unique identifier of the previous session when a new session is created for a conference
      subject:
        type: string
        description: The subject for the initial email that started this conversation
      videoMuted:
        type: boolean
        description: Flag indicating if video is muted/paused or not (true/false)
      wrapUpCode:
        type: string
        description: Wrap up code
      wrapUpNote:
        type: string
        description: Note entered by an agent during after-call work
      wrapUpTags:
        type: array
        description: Tag(s) assigned during after-call work
        items:
          type: string
      scoredAgents:
        type: array
        description: Scored agents
        items:
          $ref: '#/definitions/AnalyticsScoredAgent'
      properties:
        type: array
        description: Additional segment properties
        items:
          $ref: '#/definitions/AnalyticsProperty'
  TeamActivityResponse:
    type: object
    properties:
      results:
        type: array
        description: Query results
        items:
          $ref: '#/definitions/TeamActivityData'
      entityIdDimension:
        type: string
        description: Dimension that is used as an entityId
        enum:
        - organizationPresenceId
        - presenceDate
        - queueId
        - queueMembershipStatus
        - routingStatus
        - routingStatusDate
        - systemPresence
        - teamId
        - userId
  ConversationActivityQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/ConversationActivityQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/ConversationActivityQueryPredicate'
  FlowActivityQuery:
    type: object
    required:
    - groupBy
    - metrics
    properties:
      metrics:
        type: array
        description: List of requested metrics
        items:
          $ref: '#/definitions/FlowActivityQueryMetric'
      groupBy:
        type: array
        description: Dimension(s) to group by
        uniqueItems: true
        items:
          type: string
          enum:
          - activeRouting
          - addressFrom
          - addressTo
          - agentScore
          - ani
          - conversationId
          - convertedFrom
          - convertedTo
          - direction
          - dnis
          - flowId
          - flowType
          - mediaType
          - participantName
          - queueId
          - requestedLanguageId
          - requestedRouting
          - requestedRoutingSkillId
          - routingPriority
          - scoredAgentId
          - sessionId
          - teamId
          - usedRouting
          - userId
      filter:
        description: Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/FlowActivityQueryFilter'
      order:
        type: string
        description: Sort the result set in ascending/descending order. Default is ascending
        enum:
        - asc
        - desc
        - unordered
  SummaryAggregationSort:
    type: object
    required:
    - function
    - name
    properties:
      name:
        type: string
        description: Name of the metric used for sorting values.
        enum:
        - nConversationSummaries
        - nConversationSummaryEngagements
        - tConversationSummary
      function:
        type: string
        description: Aggregation function used for the sort metric.
        enum:
        - average
        - count
        - max
        - min
        - sum
  SummaryAggregateQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/SummaryAggregateQueryPredicate'
  FlowExecutionAsyncAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - divisionId
          - flowId
          - flowObjectId
          - flowVersion
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/FlowExecutionAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nFlowExecutions
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/FlowExecutionAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
      pageSize:
        type: integer
        format: int32
        description: The number of results per page
  ConversationAggregateQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/ConversationAggregateQueryPredicate'
  UserActivityMetricValue:
    type: object
    properties:
      metric:
        type: string
        description: Metric
        enum:
        - oActiveQueues
        - oMemberQueues
      qualifier:
        type: string
        description: Metric qualifier
      entityIds:
        type: array
        description: Entity ids for matching entities if details were requested
        uniqueItems: true
        items:
          type: string
      count:
        type: integer
        format: int32
        description: Metric count
  DashboardConfigurationQueryRequest:
    type: object
    required:
    - dashboardConfigurationIds
    properties:
      dashboardConfigurationIds:
        type: array
        description: The user supplied dashboard configuration ids
        items:
          type: string
      pageNumber:
        type: integer
        format: int32
        description: The page number of the queried response
      pageSize:
        type: integer
        format: int32
        description: The number of entities to return of the queried response. The max is 25
      sortBy:
        type: string
        description: The order in which response will be sorted
        enum:
        - Asc
        - Desc
  AnalyticsRoutingStatusRecord:
    type: object
    properties:
      startTime:
        type: string
        format: date-time
        description: 'The start time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      endTime:
        type: string
        format: date-time
        description: 'The end time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      routingStatus:
        type: string
        description: The user's ACD routing status
        enum:
        - OFF_QUEUE
        - IDLE
        - INTERACTING
        - NOT_RESPONDING
        - COMMUNICATING
  CaseManagementAggregationView:
    type: object
    required:
    - function
    - name
    - target
    properties:
      target:
        type: string
        description: Target metric name
        enum:
        - nCaseAssociationsCreated
        - nCasesDeleted
        - nCasesOpened
        - nCasesOverSla
        - nCasesPurged
        - nCasesStatusChanged
        - nCasesTerminated
        - oCasesServiceLevel
        - tCasesResolved
        - tCasesStatus
      name:
        type: string
        description: A unique name for this view. Must be distinct from other views and built-in metric names.
      function:
        type: string
        description: Type of view you wish to create
        enum:
        - rangeBound
      range:
        description: Range of numbers for slicing up data
        $ref: '#/definitions/AggregationRange'
  KnowledgeAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
        x-genesys-entity-type:
          value: INTERVAL
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - agentAssistantId
          - answerGenerationEnabled
          - appDeploymentId
          - appType
          - botFlowId
          - conversationChannelType
          - conversationId
          - documentEngagementType
          - externalContactId
          - feedbackCategory
          - feedbackId
          - feedbackRating
          - feedbackRatingType
          - feedbackRatingValue
          - feedbackReason
          - feedbackType
          - hasComment
          - hasRetrievedReferences
          - hasSearch
          - knowledgeBaseDocumentId
          - knowledgeBaseDocumentVariationId
          - knowledgeBaseDocumentVersionId
          - knowledgeBaseId
          - knowledgeSettingId
          - languageCode
          - mediaType
          - messageType
          - presentedDocumentsCount
          - queryType
          - queryTypeV3
          - queueId
          - searchId
          - searchQuery
          - selfServed
          - sessionId
          - surfacingMethod
          - userId
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/KnowledgeAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nDistinctKnowledgeSessions
          - nKnowledgeDocumentCopied
          - nKnowledgeDocumentFeedback
          - nKnowledgeDocumentPresented
          - nKnowledgeDocumentSurfaced
          - nKnowledgeDocumentViewed
          - nKnowledgeSearch
          - nKnowledgeSearchAnswered
          - nKnowledgeSearchFeedback
          - nKnowledgeSearchUnanswered
          - nKnowledgeSessions
          - nKnowledgeV3Search
          - oKnowledgeDocumentQuery
          - oKnowledgeDocumentQuerySelfServed
          - oKnowledgeSearch
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/KnowledgeAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
      queryType:
        type: string
        description: Query type to use. Use groupBy for all matching results, and topN/bottomN for N results ordered by the sortMetric. Default is groupBy.
        enum:
        - bottomN
        - groupBy
        - topN
      sortMetric:
        description: Required when requesting multiple metrics. Only applicable for topN/bottomN query type.
        $ref: '#/definitions/KnowledgeAggregationSort'
      limit:
        type: integer
        format: int32
        description: How many results you want in an ordered list. Only applicable for topN/bottomN query type.
  JourneyAggregateQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - containsAllCondition
        - containsAnyCondition
        - endsWithCondition
        - equalCondition
        - journeyActionId
        - journeyActionMapId
        - journeyActionMapVersion
        - journeyActionMediaType
        - journeyActionTargetId
        - journeyActionTemplateId
        - journeyBlockingActionMapId
        - journeyBlockingEmergencyScheduleGroupId
        - journeyBlockingReason
        - journeyBlockingScheduleGroupId
        - journeyDeviceCategory
        - journeyDeviceType
        - journeyFrequencyCapReason
        - journeyIpGeolocationCountry
        - journeyOutcomeId
        - journeySegmentAssignmentState
        - journeySegmentId
        - journeySessionId
        - journeySessionSegmentId
        - journeySessionType
        - notContainsAllCondition
        - notContainsAnyCondition
        - notEqualCondition
        - startsWithCondition
        - touchpointActionMapId
        - touchpointAgentId
        - touchpointAttributionScope
        - touchpointChannelMessageType
        - touchpointChannelPlatform
        - touchpointChannelType
        - touchpointConversationId
        - touchpointInteractionType
        - touchpointQueueId
        - touchpointRequestedRouting
        - touchpointUsedRouting
        - touchpointWrapupCode
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension predicates
        $ref: '#/definitions/NumericRange'
  TranscriptAsyncAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - addressFrom
          - addressTo
          - ani
          - categoryId
          - channel
          - conversationId
          - direction
          - divisionId
          - dnis
          - flowId
          - flowVersion
          - mediaType
          - messageType
          - queueId
          - teamId
          - topicId
          - userId
          - wrapUpCode
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/TranscriptAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nSpeechTextAnalyzedConversations
          - nTopicCommunications
          - oCustomerSentiment
          - oOverTalkSpeechInstances
          - oSentimentScore
          - tAgentSpeech
          - tCustomerSpeech
          - tOtherAudio
          - tOverTalkSpeech
          - tSilence
          - tTotalSpeechAndSilence
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/TranscriptAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
      queryType:
        type: string
        description: Query type to use. Use groupBy for all matching results, and topN/bottomN for N results ordered by the sortMetric. Default is groupBy.
        enum:
        - bottomN
        - groupBy
        - topN
      sortMetric:
        description: Required when requesting multiple metrics. Only applicable for topN/bottomN query type.
        $ref: '#/definitions/TranscriptAggregationSort'
      limit:
        type: integer
        format: int32
        description: How many results you want in an ordered list. Only applicable for topN/bottomN query type.
      pageSize:
        type: integer
        format: int32
        description: The number of results per page
  AgentStateQueryRequest:
    type: object
    properties:
      userFilter:
        description: Filters that target user-level data
        $ref: '#/definitions/AgentStateUserFilter'
      sessionFilter:
        description: Filters that target session-level data
        $ref: '#/definitions/AgentStateSessionFilter'
      userOrderBy:
        type: string
        description: Search user order dimension names; default to userName
        enum:
        - userName
        - segmentStart
        - sessionStart
        - presenceDate
        - routingStatusDate
        - systemPresence
        - routingStatus
        - organizationPresenceId
        - adherenceDate
      userOrder:
        type: string
        description: Search user order direction; default to asc
        enum:
        - asc
        - desc
      sessionOrderBy:
        type: string
        description: Search session order dimension names; default to segmentStart
        enum:
        - segmentStart
        - sessionStart
      sessionOrder:
        type: string
        description: Search session order direction; default to asc
        enum:
        - asc
        - desc
  BotAggregateQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/BotAggregateQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/BotAggregateQueryPredicate'
  AnalyticsFlow:
    type: object
    properties:
      endingLanguage:
        type: string
        description: Flow ending language, e.g. en-us
      entryReason:
        type: string
        description: The particular entry reason for this flow, e.g. an address, userId, or flowId
      entryType:
        type: string
        description: The entry type for this flow, e.g. dnis, dialer, agent, flow, or direct
        enum:
        - agent
        - direct
        - dnis
        - flow
        - outbound
      exitReason:
        type: string
        description: The exit reason for this flow, e.g. DISCONNECT
      flowId:
        type: string
        description: The unique identifier of this flow
      flowName:
        type: string
        description: The name of this flow at the time of flow execution
      flowType:
        type: string
        description: The type of this flow
        enum:
        - BOT
        - COMMONMODULE
        - DIGITALBOT
        - EMAILSEND
        - INBOUNDCALL
        - INBOUNDCHAT
        - INBOUNDEMAIL
        - INBOUNDSHORTMESSAGE
        - INQUEUECALL
        - INQUEUEEMAIL
        - INQUEUESHORTMESSAGE
        - OUTBOUNDCALL
        - SECURECALL
        - SPEECH
        - SURVEYINVITE
        - VOICE
        - VOICEMAIL
        - VOICESURVEY
        - WORKFLOW
        - WORKITEM
      flowVersion:
        type: string
        description: The version of this flow
      issuedCallback:
        type: boolean
        description: Flag indicating whether the flow issued a callback
      recognitionFailureReason:
        type: string
        description: The recognition failure reason causing to exit/disconnect
      startingLanguage:
        type: string
        description: Flow starting language, e.g. en-us
      transferTargetAddress:
        type: string
        description: The address of a flow transfer target, e.g. a phone number, an email address, or a queueId
      transferTargetName:
        type: string
        description: The name of a flow transfer target
      transferType:
        type: string
        description: The type of transfer for flows that ended with a transfer
      outcomes:
        type: array
        description: Flow outcomes
        items:
          $ref: '#/definitions/AnalyticsFlowOutcome'
  BotAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/BotAggregateDataContainer'
  FlowExecutionAggregateQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - divisionId
        - flowId
        - flowObjectId
        - flowVersion
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension predicates
        $ref: '#/definitions/NumericRange'
  SocialNumericRange:
    type: object
    properties:
      eq:
        type: number
        description: Equals to
      gt:
        type: number
        description: Greater than
      gte:
        type: number
        description: Greater than or equal to
      lt:
        type: number
        description: Less than
      lte:
        type: number
        description: Less than or equal to
  ConversationQuery:
    type: object
    required:
    - interval
    properties:
      conversationFilters:
        type: array
        description: Filters that target conversation-level data
        items:
          $ref: '#/definitions/ConversationDetailQueryFilter'
      segmentFilters:
        type: array
        description: Filters that target individual segments within a conversation
        items:
          $ref: '#/definitions/SegmentDetailQueryFilter'
      evaluationFilters:
        type: array
        description: Filters that target evaluations
        items:
          $ref: '#/definitions/EvaluationDetailQueryFilter'
      surveyFilters:
        type: array
        description: Filters that target surveys
        items:
          $ref: '#/definitions/SurveyDetailQueryFilter'
      resolutionFilters:
        type: array
        description: Filters that target resolutions
        items:
          $ref: '#/definitions/ResolutionDetailQueryFilter'
      order:
        type: string
        description: Sort the result set in ascending/descending order. Default is ascending
        enum:
        - asc
        - desc
        - unordered
      orderBy:
        type: string
        description: 'Specify which data element within the result set to use for sorting. The options  to use as a basis for sorting the results: conversationStart, segmentStart, and segmentEnd. If not specified, the default is conversationStart'
        enum:
        - conversationStart
        - conversationEnd
        - segmentStart
        - segmentEnd
      interval:
        type: string
        format: interval
        description: 'Specifies the date and time range of data being queried. Results will only include conversations that started on a day touched by the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
      aggregations:
        type: array
        description: Include faceted search and aggregate roll-ups describing your search results. This does not function as a filter, but rather, summary data about the data matching your filters
        items:
          $ref: '#/definitions/AnalyticsQueryAggregation'
      paging:
        description: Page size and number to control iterating through large result sets. Default page size is 25
        $ref: '#/definitions/PagingSpec'
  AnalyticsSession:
    type: object
    properties:
      activeSkillIds:
        type: array
        description: ID(s) of Skill(s) that are active on the conversation
        items:
          type: string
      acwSkipped:
        type: boolean
        description: Marker for an agent that skipped after call work
      addressFrom:
        type: string
        description: The address that initiated an action
      addressOther:
        type: string
        description: The email address for the participant on the other side of the email conversation
      addressSelf:
        type: string
        description: The email address for the participant on this side of the email conversation
      addressTo:
        type: string
        description: The address receiving an action
      agentAssistantId:
        type: string
        description: Unique identifier of the active virtual agent assistant
      agentBullseyeRing:
        type: integer
        format: int32
        description: Bullseye ring of the targeted agent
      agentOwned:
        type: boolean
        description: Flag indicating an agent-owned callback
      ani:
        type: string
        description: Automatic Number Identification (caller's number)
      assignerId:
        type: string
        description: ID of the user that manually assigned a conversation
      authenticated:
        type: boolean
        description: Flag that indicates that the identity of the customer has been asserted as verified by the provider.
      bargedParticipantId:
        type: string
        description: The participantId being barged in on (if someone (e.g. an agent) is being barged in on, this would correspond to one of the other participantIds present in the conversation)
      bcc:
        type: array
        description: Blind carbon copy email address(es)
        items:
          type: string
      callbackNumbers:
        type: array
        description: Callback phone number(s)
        items:
          type: string
      callbackScheduledTime:
        type: string
        format: date-time
        description: 'Scheduled callback date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      callbackUserName:
        type: string
        description: The name of the user requesting a call back
      cc:
        type: array
        description: Carbon copy email address(es)
        items:
          type: string
      cleared:
        type: boolean
        description: Flag that indicates that the conversation has been cleared by the customer
      coachedParticipantId:
        type: string
        description: The participantId being coached (if someone (e.g. an agent) is being coached, this would correspond to one of the other participantIds present in the conversation)
      cobrowseRole:
        type: string
        description: Describes side of the cobrowse (sharer or viewer)
      cobrowseRoomId:
        type: string
        description: A unique identifier for a Genesys Cloud cobrowse room
      deliveryPushed:
        type: boolean
        description: Flag that indicates that the push delivery mechanism was used
      deliveryStatus:
        type: string
        description: The email or SMS delivery status
        enum:
        - DeliveryFailed
        - DeliveryPushed
        - DeliverySuccess
        - Failed
        - Published
        - Queued
        - Read
        - Received
        - Sent
      deliveryStatusChangeDate:
        type: string
        format: date-time
        description: 'Date and time of the most recent delivery status change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      destinationAddresses:
        type: array
        description: Destination address(es) of transfers or consults
        items:
          type: string
      detectedSpeechEnd:
        type: string
        format: date-time
        description: 'Absolute time when the speech ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      detectedSpeechStart:
        type: string
        format: date-time
        description: 'Absolute time when the speech started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      direction:
        type: string
        description: The direction of the communication
        enum:
        - inbound
        - outbound
      dispositionAnalyzer:
        type: string
        description: (Dialer) Analyzer (for example speech.person)
      dispositionName:
        type: string
        description: (Dialer) Result of the analysis (for example disposition.classification.callable.machine)
      dnis:
        type: string
        description: Dialed number identification service (number dialed by the calling party)
      edgeId:
        type: string
        description: Unique identifier of the edge device
      eligibleAgentCounts:
        type: array
        description: Number of eligible agents for each predictive routing attempt
        items:
          type: integer
          format: int32
      engagementSource:
        type: string
        description: Open Messaging engagement source type
        enum:
        - AppleMessagesForBusiness
        - Discord
        - Email
        - Facebook
        - FacebookMessenger
        - Glassdoor
        - GoogleBusinessProfile
        - Instagram
        - KakaoTalk
        - Line
        - LinkedIn
        - MicrosoftTeams
        - MobileChat
        - Other
        - QQ
        - Reddit
        - ServiceNow
        - SFDC
        - SMS
        - Snapchat
        - Telegram
        - Threads
        - Trustpilot
        - Unspecified
        - Viber
        - WebChat
        - WeChat
        - Weibo
        - WhatsApp
        - X
        - Yelp
        - YouTube
        - Zendesk
        - OpenMessaging
      errorCodeDescription:
        type: string
        description: Error code description extracted from the first disconnectReason
      extendedDeliveryStatus:
        type: string
        description: Extended delivery status
      flowInType:
        type: string
        description: Type of flow in that occurred when entering ACD.
      flowOutType:
        type: string
        description: Type of flow out that occurred when emitting tFlowOut.
      journeyActionId:
        type: string
        description: Identifier of the journey action.
      journeyActionMapId:
        type: string
        description: Identifier of the journey action map that triggered the action.
      journeyActionMapVersion:
        type: integer
        format: int32
        description: Version of the journey action map that triggered the action.
      journeyCustomerId:
        type: string
        description: Primary identifier of the journey customer in the source where the activities originate from.
      journeyCustomerIdType:
        type: string
        description: Type of primary identifier of the journey customer (e.g. cookie).
      journeyCustomerSessionId:
        type: string
        description: Unique identifier of the journey session.
      journeyCustomerSessionIdType:
        type: string
        description: Type or category of journey sessions (e.g. web, ticket, delivery, atm).
      mediaBridgeId:
        type: string
        description: Media bridge ID for the conference session consistent across all participants
      mediaCount:
        type: integer
        format: int32
        description: Count of any media (images, files, etc) included in this session
      mediaType:
        type: string
        description: The session media type
        enum:
        - callback
        - chat
        - cobrowse
        - email
        - internalmessage
        - message
        - screenmonitoring
        - screenshare
        - unknown
        - video
        - voice
      messageType:
        type: string
        description: 'Message type for messaging services. E.g.: sms, facebook, twitter, line'
      monitoredParticipantId:
        type: string
        description: The participantId being monitored (if someone (e.g. an agent) is being monitored, this would correspond to one of the other participantIds present in the conversation)
      outboundCampaignId:
        type: string
        description: (Dialer) Unique identifier of the outbound campaign
      outboundContactId:
        type: string
        description: (Dialer) Unique identifier of the contact
      outboundContactListId:
        type: string
        description: (Dialer) Unique identifier of the contact list that this contact belongs to
      peerId:
        type: string
        description: This identifies pairs of related sessions on a conversation. E.g. an external session’s peerId will be the session that the call originally connected to, e.g. if an IVR was dialed, the IVR session, which will also have the external session’s ID as its peer. After that point, any transfers of that session to other internal components (acd, agent, etc.) will all spawn new sessions whose peerIds point back to that original external session.
      protocolCallId:
        type: string
        description: The original voice protocol call ID, e.g. a SIP call ID
      provider:
        type: string
        description: The source provider for the communication.
      recording:
        type: boolean
        description: Flag determining if an audio recording was started or not
      remote:
        type: string
        description: Name, phone number, or email address of the remote party.
      remoteNameDisplayable:
        type: string
        description: Unique identifier for the remote party
      removedSkillIds:
        type: array
        description: ID(s) of Skill(s) that have been removed by bullseye routing
        items:
          type: string
      requestedRoutings:
        type: array
        description: Routing type(s) for requested/attempted routing methods.
        items:
          type: string
          enum:
          - Bullseye
          - Conditional
          - Direct
          - Last
          - Manual
          - Predictive
          - Preferred
          - Standard
          - Vip
      roomId:
        type: string
        description: Unique identifier for the room
      routingRing:
        type: integer
        format: int32
        description: Routing ring for bullseye or preferred agent routing
      routingRule:
        type: string
        description: Routing rule for preferred, conditional and predictive routing type
      routingRuleType:
        type: string
        description: Routing rule type
        enum:
        - Bullseye
        - Conditional
        - Predictive
        - Preferred
      screenMonitoredUserId:
        type: string
        description: The user ID for the participant who is being screen monitored.
      screenShareAddressSelf:
        type: string
        description: Direct screen share address
      screenShareRoomId:
        type: string
        description: A unique identifier for a Genesys Cloud screen share room
      scriptId:
        type: string
        description: A unique identifier for a script
      selectedAgentId:
        type: string
        description: Selected agent ID
      selectedAgentRank:
        type: integer
        format: int32
        description: Selected agent GPR rank
      sessionDnis:
        type: string
        description: Dialed number for the current session; this can be different from dnis, e.g. if the call was transferred
      sessionId:
        type: string
        description: The unique identifier of this session
      sharingScreen:
        type: boolean
        description: Flag determining if screen share is started or not (true/false)
      skillExpressionId:
        type: string
        description: Unique identifier for the skill requested for an interaction
      skipEnabled:
        type: boolean
        description: (Dialer) Whether the agent can skip the dialer contact
      snippetRecording:
        type: boolean
        description: Whether or not the conversation included a snippet being recorded.
      timeoutSeconds:
        type: integer
        format: int32
        description: The number of seconds before Genesys Cloud begins the call for a call back (0 disables automatic calling)
      usedRouting:
        type: string
        description: Complete routing method
        enum:
        - Bullseye
        - Conditional
        - Direct
        - Last
        - Manual
        - Predictive
        - Preferred
        - Standard
        - Vip
      videoAddressSelf:
        type: string
        description: Direct Video address
      videoRoomId:
        type: string
        description: A unique identifier for a Genesys Cloud video room
      waitingInteractionCounts:
        type: array
        description: Number of waiting interactions for each predictive routing attempt
        items:
          type: integer
          format: int32
      agentGroups:
        type: array
        description: Conditional group routing agent groups
        items:
          $ref: '#/definitions/AnalyticsAgentGroup'
      proposedAgents:
        type: array
        description: Proposed agents
        items:
          $ref: '#/definitions/AnalyticsProposedAgent'
      mediaEndpointStats:
        type: array
        description: MediaEndpointStats associated with this session
        items:
          $ref: '#/definitions/AnalyticsMediaEndpointStat'
      flow:
        description: IVR flow execution associated with this session
        $ref: '#/definitions/AnalyticsFlow'
      metrics:
        type: array
        description: List of metrics for this session
        items:
          $ref: '#/definitions/AnalyticsSessionMetric'
      segments:
        type: array
        description: List of segments for this session
        items:
          $ref: '#/definitions/AnalyticsConversationSegment'
  RateLimitAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
        x-genesys-entity-type:
          value: INTERVAL
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - correlationId
          - entityId
          - limitName
          - max
          - namespace
          - timeUnit
          - userId
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/RateLimitAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - oRateLimitRecorded
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/RateLimitAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
  SummaryAggregateQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/SummaryAggregateQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/SummaryAggregateQueryPredicate'
  UserAggregateQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - userId
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension predicates
        $ref: '#/definitions/NumericRange'
  BotAggregateQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/BotAggregateQueryPredicate'
  AgentStateAgentQueryPredicate:
    type: object
    required:
    - dimension
    - value
    properties:
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - activeQueueId
        - inactiveQueueId
        - queueId
        - assignedSkillId
        - assignedLanguageId
        - divisionId
        - userId
        - managerId
        - systemPresence
        - organizationPresenceId
        - routingStatus
        - isOutOfOffice
        - online
        - teamId
        - managementUnitId
        - businessUnitId
        - adherenceState
        - adherenceImpact
        - scheduledActivityCodeId
        - scheduledActivityCategory
        - actualActivityCategory
      value:
        type: string
        description: Right hand side for dimension predicates
  JourneyAggregateQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/JourneyAggregateQueryPredicate'
  ViewFilter:
    type: object
    properties:
      mediaTypes:
        type: array
        description: The media types are used to filter the view
        items:
          type: string
          enum:
          - callback
          - chat
          - cobrowse
          - email
          - internalmessage
          - message
          - screenmonitoring
          - screenshare
          - unknown
          - video
          - voice
      queueIds:
        type: array
        description: The queue ids are used to filter the view
        items:
          type: string
        x-genesys-entity-type:
          value: QUEUE_ID
      skillIds:
        type: array
        description: The skill ids are used to filter the view
        items:
          type: string
      assignedSkillIds:
        type: array
        description: The assigned user skill ids are used to filter the view
        items:
          type: string
      skillGroups:
        type: array
        description: The skill groups used to filter the view
        items:
          type: string
      languageIds:
        type: array
        description: The language ids are used to filter the view
        items:
          type: string
      assignedLanguageIds:
        type: array
        description: The assigned user language ids are used to filter the view
        items:
          type: string
      languageGroups:
        type: array
        description: The language groups used to filter the view
        items:
          type: string
      directions:
        type: array
        description: The directions are used to filter the view
        items:
          type: string
          enum:
          - inbound
          - outbound
      originatingDirections:
        type: array
        description: The list of orginating directions used to filter the view
        items:
          type: string
          enum:
          - inbound
          - outbound
      wrapUpCodes:
        type: array
        description: The wrap up codes are used to filter the view
        items:
          type: string
      dnisList:
        type: array
        description: The dnis list is used to filter the view
        items:
          type: string
      sessionDnisList:
        type: array
        description: The list of session dnis used to filter the view
        items:
          type: string
      filterQueuesByUserIds:
        type: array
        description: The user ids are used to fetch associated queues for the view
        items:
          type: string
        x-genesys-entity-type:
          value: USER_ID
      filterUsersByQueueIds:
        type: array
        description: The queue ids are used to fetch associated users for the view
        items:
          type: string
        x-genesys-entity-type:
          value: QUEUE_ID
      userIds:
        type: array
        description: The user ids are used to filter the view
        items:
          type: string
        x-genesys-entity-type:
          value: USER_ID
      managementUnitIds:
        type: array
        description: The management unit ids are used to filter the view
        items:
          type: string
      addressTos:
        type: array
        description: The address To values are used to filter the view
        items:
          type: string
      addressFroms:
        type: array
        description: The address from values are used to filter the view
        items:
          type: string
      outboundCampaignIds:
        type: array
        description: The outbound campaign ids are used to filter the view
        items:
          type: string
      outboundContactListIds:
        type: array
        description: The outbound contact list ids are used to filter the view
        items:
          type: string
      contactIds:
        type: array
        description: The contact ids are used to filter the view
        items:
          type: string
      externalContactIds:
        type: array
        description: The external contact ids are used to filter the view
        items:
          type: string
      externalOrgIds:
        type: array
        description: The external org ids are used to filter the view
        items:
          type: string
      aniList:
        type: array
        description: The ani list ids are used to filter the view
        items:
          type: string
      durationsMilliseconds:
        type: array
        description: The durations in milliseconds used to filter the view
        items:
          $ref: '#/definitions/NumericRange'
      acdDurationsMilliseconds:
        type: array
        description: The acd durations in milliseconds used to filter the view
        items:
          $ref: '#/definitions/NumericRange'
      talkDurationsMilliseconds:
        type: array
        description: The talk durations in milliseconds used to filter the view
        items:
          $ref: '#/definitions/NumericRange'
      acwDurationsMilliseconds:
        type: array
        description: The acw durations in milliseconds used to filter the view
        items:
          $ref: '#/definitions/NumericRange'
      handleDurationsMilliseconds:
        type: array
        description: The handle durations in milliseconds used to filter the view
        items:
          $ref: '#/definitions/NumericRange'
      holdDurationsMilliseconds:
        type: array
        description: The hold durations in milliseconds used to filter the view
        items:
          $ref: '#/definitions/NumericRange'
      abandonDurationsMilliseconds:
        type: array
        description: The abandon durations in milliseconds used to filter the view
        items:
          $ref: '#/definitions/NumericRange'
      evaluationScore:
        description: The evaluationScore is used to filter the view
        $ref: '#/definitions/NumericRange'
      evaluationCriticalScore:
        description: The evaluationCriticalScore is used to filter the view
        $ref: '#/definitions/NumericRange'
      evaluationFormIds:
        type: array
        description: The evaluation form ids are used to filter the view
        items:
          type: string
      evaluatedAgentIds:
        type: array
        description: The evaluated agent ids are used to filter the view
        items:
          type: string
      evaluatorIds:
        type: array
        description: The evaluator ids are used to filter the view
        items:
          type: string
      transferred:
        type: boolean
        description: Indicates filtering for transfers
      abandoned:
        type: boolean
        description: Indicates filtering for abandons
      answered:
        type: boolean
        description: Indicates filtering for answered interactions
      messageTypes:
        type: array
        description: The message media types used to filter the view
        items:
          type: string
          enum:
          - sms
          - twitter
          - line
          - facebook
          - whatsapp
          - webmessaging
          - open
          - instagram
          - apple
      divisionIds:
        type: array
        description: The divison Ids used to filter the view
        items:
          type: string
        x-genesys-entity-type:
          value: DIVISION_ID
      surveyFormIds:
        type: array
        description: The survey form ids used to filter the view
        items:
          type: string
      surveyTotalScore:
        description: The survey total score used to filter the view
        $ref: '#/definitions/NumericRange'
      surveyNpsScore:
        description: The survey NPS score used to filter the view
        $ref: '#/definitions/NumericRange'
      mos:
        description: The desired range for mos values
        $ref: '#/definitions/NumericRange'
      surveyQuestionGroupScore:
        description: The survey question group score used to filter the view
        $ref: '#/definitions/NumericRange'
      surveyPromoterScore:
        description: The survey promoter score used to filter the view
        $ref: '#/definitions/NumericRange'
      surveyFormContextIds:
        type: array
        description: The list of survey form context ids used to filter the view
        items:
          type: string
      conversationIds:
        type: array
        description: The list of conversation ids used to filter the view
        items:
          type: string
      sipCallIds:
        type: array
        description: The list of SIP call ids used to filter the view
        items:
          type: string
      isEnded:
        type: boolean
        description: Indicates filtering for ended
      isSurveyed:
        type: boolean
        description: Indicates filtering for survey
      surveyScores:
        type: array
        description: The list of survey score ranges used to filter the view
        items:
          $ref: '#/definitions/NumericRange'
      promoterScores:
        type: array
        description: The list of promoter score ranges used to filter the view
        items:
          $ref: '#/definitions/NumericRange'
      isCampaign:
        type: boolean
        description: Indicates filtering for campaign
      surveyStatuses:
        type: array
        description: The list of survey statuses used to filter the view
        items:
          type: string
      conversationProperties:
        description: A grouping of conversation level filters
        $ref: '#/definitions/ConversationProperties'
      isBlindTransferred:
        type: boolean
        description: Indicates filtering for blind transferred
      isConsulted:
        type: boolean
        description: Indicates filtering for consulted
      isConsultTransferred:
        type: boolean
        description: Indicates filtering for consult transferred
      remoteParticipants:
        type: array
        description: The list of remote participants used to filter the view
        items:
          type: string
      flowIds:
        type: array
        description: The list of flow Ids
        items:
          type: string
      flowOutcomeIds:
        type: array
        description: A list of outcome ids of the flow
        items:
          type: string
      flowOutcomeValues:
        type: array
        description: A list of outcome values of the flow
        items:
          type: string
          enum:
          - SUCCESS
          - FAILURE
      flowDestinationTypes:
        type: array
        description: The list of destination types of the flow
        items:
          type: string
          enum:
          - ACD
          - USER
          - GROUP
          - NUMBER
          - FLOW
          - SECURE_FLOW
          - ACD_VOICEMAIL
          - USER_VOICEMAIL
          - GROUP_VOICEMAIL
          - RETURN_TO_AGENT
      flowDisconnectReasons:
        type: array
        description: The list of reasons for the flow to disconnect
        items:
          type: string
          enum:
          - FLOW_DISCONNECT
          - FLOW_ERROR_DISCONNECT
          - DISCONNECT
      flowTypes:
        type: array
        description: A list of types of the flow
        items:
          type: string
          enum:
          - bot
          - commonmodule
          - digitalbot
          - emailsend
          - inboundcall
          - inboundchat
          - inboundemail
          - inboundshortmessage
          - inqueuecall
          - inqueueshortmessage
          - inqueueemail
          - outboundcall
          - securecall
          - surveyinvite
          - voice
          - voicemail
          - voicesurvey
          - workflow
          - workitem
      flowEntryTypes:
        type: array
        description: A list of types of the flow entry
        items:
          type: string
          enum:
          - agent
          - direct
          - dnis
          - flow
          - outbound
      flowEntryReasons:
        type: array
        description: A list of reasons of flow entry
        items:
          type: string
      flowVersions:
        type: array
        description: A list of versions of a flow
        items:
          type: string
      groupIds:
        type: array
        description: A list of directory group ids
        items:
          type: string
      hasJourneyCustomerId:
        type: boolean
        description: Indicates filtering for journey customer id
      hasJourneyActionMapId:
        type: boolean
        description: Indicates filtering for Journey action map id
      hasJourneyVisitId:
        type: boolean
        description: Indicates filtering for Journey visit id
      hasMedia:
        type: boolean
        description: Indicates filtering for presence of MMS media
      roleIds:
        type: array
        description: The role Ids used to filter the view
        items:
          type: string
      reportsTos:
        type: array
        description: The report to user IDs used to filter the view
        items:
          type: string
      locationIds:
        type: array
        description: The location Ids used to filter the view
        items:
          type: string
      flowOutTypes:
        type: array
        description: A list of flow out types
        items:
          type: string
      providerList:
        type: array
        description: A list of providers
        items:
          type: string
      callbackNumberList:
        type: array
        description: 'A list of callback numbers or substrings of numbers (ex: ["317", "13172222222"])'
        items:
          type: string
      callbackInterval:
        type: string
        format: interval
        description: 'An interval of time to filter for scheduled callbacks. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
      usedRoutingTypes:
        type: array
        description: A list of routing types used
        items:
          type: string
          enum:
          - Bullseye
          - Conditional
          - Direct
          - Last
          - Manual
          - Predictive
          - Preferred
          - Standard
          - Vip
      requestedRoutingTypes:
        type: array
        description: A list of routing types requested
        items:
          type: string
          enum:
          - Bullseye
          - Conditional
          - Direct
          - Last
          - Manual
          - Predictive
          - Preferred
          - Standard
          - Vip
      hasAgentAssistId:
        type: boolean
        description: Indicates filtering for agent assist id
      transcripts:
        type: array
        description: A list of transcript contents requested
        items:
          $ref: '#/definitions/Transcripts'
      transcriptLanguages:
        type: array
        description: A list of transcript languages requested
        items:
          type: string
      participantPurposes:
        type: array
        description: A list of participant purpose requested
        items:
          type: string
          enum:
          - internal
          - external
      showFirstQueue:
        type: boolean
        description: Indicates filtering for first queue data
      teamIds:
        type: array
        description: The team ids used to filter the view data
        items:
          type: string
      filterUsersByTeamIds:
        type: array
        description: The team ids are used to fetch associated users for the view
        items:
          type: string
      journeyActionMapIds:
        type: array
        description: The journey action map ids are used to fetch action maps for the associated view
        items:
          type: string
      journeyOutcomeIds:
        type: array
        description: The journey outcome ids are used to fetch outcomes for the associated view
        items:
          type: string
      journeySegmentIds:
        type: array
        description: The journey segment ids are used to fetch segments for the associated view
        items:
          type: string
      journeyActionMapTypes:
        type: array
        description: The journey action map types are used to filter action map data for the associated view
        items:
          type: string
          enum:
          - webchat
          - webMessagingOffer
          - contentOffer
          - integrationAction
          - architectFlow
          - openAction
      developmentRoleList:
        type: array
        description: The list of development roles used to filter agent development view
        items:
          type: string
          enum:
          - Creator
          - Facilitator
          - Attendee
      developmentTypeList:
        type: array
        description: The list of development types used to filter agent development view
        items:
          type: string
          enum:
          - Informational
          - Coaching
          - Assessment
          - AssessedContent
          - External
          - Native
      developmentStatusList:
        type: array
        description: The list of development status used to filter agent development view
        items:
          type: string
          enum:
          - Planned
          - Scheduled
          - InvalidSchedule
          - InProgress
          - Completed
          - NotCompleted
      developmentModuleIds:
        type: array
        description: The list of development moduleIds used to filter agent development view
        items:
          type: string
      developmentActivityOverdue:
        type: boolean
        description: Indicates filtering for development activities
      customerSentimentScore:
        description: The customer sentiment score used to filter the view
        $ref: '#/definitions/NumericRange'
      customerSentimentTrend:
        description: The customer sentiment trend used to filter the view
        $ref: '#/definitions/NumericRange'
      flowTransferTargets:
        type: array
        description: The list of transfer targets used to filter flow data
        items:
          type: string
      developmentName:
        type: string
        description: Filter for development name
      topicIds:
        type: array
        description: Represents the topics detected in the transcript
        items:
          type: string
      externalTags:
        type: array
        description: The list of external Tags used to filter conversation data
        items:
          type: string
      isNotResponding:
        type: boolean
        description: Indicates filtering for not responding users
      isAuthenticated:
        type: boolean
        description: Indicates filtering for the authenticated chat
      botIds:
        type: array
        description: The list of bot IDs used to filter bot views
        items:
          type: string
      botVersions:
        type: array
        description: The list of bot versions used to filter bot views
        items:
          type: string
      botMessageTypes:
        type: array
        description: The list of bot message types used to filter bot views
        items:
          type: string
          enum:
          - Unknown
          - Phone
          - SMS
          - GenesysChatWidget
          - FacebookMessenger
          - WeChat
          - Whatsapp
          - AppleBusinessChat
          - Telegram
          - Slack
          - Signal
          - Line
          - Discord
          - TwitterDirectMessage
          - Open
          - Instagram
          - Apple
          - Other
      botProviderList:
        type: array
        description: The list of bot providers used to filter bot views
        items:
          type: string
          enum:
          - Unknown
          - Genesys
          - Amazon
          - Google
          - Nuance
      botProductList:
        type: array
        description: The list of bot products used to filter bot views
        items:
          type: string
          enum:
          - Unknown
          - GenesysDialogEngine
          - AmazonLex
          - GoogleDialogFlow
          - GoogleDialogFlowResell
          - GenesysBotFlow
          - NuanceDlg
          - GoogleDialogFlowCx
          - GenesysByob
          - AmazonLexV2
          - GoogleDialogFlowCxResell
          - GoogleSttBotFlow
          - MicrosoftSttBotFlow
          - AudioConnector
          - BotConnector
      botRecognitionFailureReasonList:
        type: array
        description: The list of bot recognition failure reasons used to filter bot views
        items:
          type: string
          enum:
          - Unknown
          - NoInputCollection
          - NoInputConfirmation
          - NoInputDisambiguation
          - NoMatchCollection
          - NoMatchConfirmation
          - NoMatchDisambiguation
          - MaxWrongMatch
          - AllOptionsRejected
      botIntentList:
        type: array
        description: The list of bot intents used to filter bot views
        items:
          type: string
      botFinalIntentList:
        type: array
        description: The list of bot final intents used to filter bot views
        items:
          type: string
      botSlotList:
        type: array
        description: The list of bot slots used to filter bot views
        items:
          type: string
      botResultList:
        type: array
        description: The list of bot results used to filter bot views
        items:
          type: string
          enum:
          - Unknown
          - ExitRequestedByUser
          - ExitRequestedByBot
          - ExitError
          - ExitRecognitionFailure
          - DisconnectRequestedByUser
          - DisconnectRequestedByBot
          - DisconnectSessionExpired
          - DisconnectError
          - DisconnectRecognitionFailure
          - TransferToACD
          - TransferToUser
          - TransferToGroup
          - TransferToNumber
          - TransferToUserVoicemail
          - TransferToGroupVoicemail
          - TransferToACDVoicemail
      blockedReasons:
        type: array
        description: The list of blocked reason used to filter action map constraints views
        items:
          type: string
          enum:
          - PageUrlConditionsNotMatching
          - AlreadyExistingOffer
          - TriggerDateInFuture
          - MultipleSimultaneousOffers
          - FrequencyCapping
          - OfferedOutsideSchedule
          - ServiceLevelThrottling
          - NoAvailableAgents
      isRecorded:
        type: boolean
        description: Indicates filtering for recorded
      hasEvaluation:
        type: boolean
        description: Indicates filtering for evaluation
      hasScoredEvaluation:
        type: boolean
        description: Indicates filtering for scored evaluation
      emailDeliveryStatusList:
        type: array
        description: The list of email delivery statuses used to filter views
        items:
          type: string
          enum:
          - DeliveryFailed
          - DeliveryPushed
          - DeliverySuccess
          - Failed
          - Published
          - Queued
          - Read
          - Received
          - Sent
      isAgentOwnedCallback:
        type: boolean
        description: Indicates filtering for agent owned callback interactions
      agentCallbackOwnerIds:
        type: array
        description: The list of callback owners used to filter interactions
        items:
          type: string
      transcriptTopics:
        type: array
        description: The list of transcript topics requested in filter
        items:
          $ref: '#/definitions/TranscriptTopics'
      journeyFrequencyCapReasons:
        type: array
        description: The list of frequency cap reasons to filter offer constraints
        items:
          type: string
      journeyBlockingActionMapIds:
        type: array
        description: The list of blocking action maps to filter offer constraints
        items:
          type: string
      journeyActionTargetIds:
        type: array
        description: The list of action targets to filter offer constraints
        items:
          type: string
      journeyBlockingScheduleGroupIds:
        type: array
        description: The list of blocking schedule groups to filter offer constraints
        items:
          type: string
      journeyBlockingEmergencyScheduleGroupIds:
        type: array
        description: The list of emergency schedule groups to filter offer constraints
        items:
          type: string
      journeyUrlEqualConditions:
        type: array
        description: The list of url equal conditions to filter offer constraints
        items:
          type: string
      journeyUrlNotEqualConditions:
        type: array
        description: The list of url not equal conditions to filter offer constraints
        items:
          type: string
      journeyUrlStartsWithConditions:
        type: array
        description: The list of url starts with conditions to filter offer constraints
        items:
          type: string
      journeyUrlEndsWithConditions:
        type: array
        description: The list of url ends with conditions to filter offer constraints
        items:
          type: string
      journeyUrlContainsAnyConditions:
        type: array
        description: The list of url contains any conditions to filter offer constraints
        items:
          type: string
      journeyUrlNotContainsAnyConditions:
        type: array
        description: The list of url not contains any conditions to filter offer constraints
        items:
          type: string
      journeyUrlContainsAllConditions:
        type: array
        description: The list of url contains all conditions to filter offer constraints
        items:
          type: string
      journeyUrlNotContainsAllConditions:
        type: array
        description: The list of url not contains all conditions to filter offer constraints
        items:
          type: string
      flowMilestoneIds:
        type: array
        description: The list of flow milestones to filter exports
        items:
          type: string
      isAssessmentPassed:
        type: boolean
        description: Filter to indicate if Agent passed assessment or not
      conversationInitiators:
        type: array
        description: The list to filter based on Brands (Bot/User/Agent) or End User who initiated the first message in the conversation
        items:
          type: string
      hasCustomerParticipated:
        type: boolean
        description: Indicates if the customer has participated in an initiated conversation
      isAcdInteraction:
        type: boolean
        description: Filter to indicate if interaction was ACD or non-ACD
      hasFax:
        type: boolean
        description: Filters to indicate if interaction has FAX
      dataActionIds:
        type: array
        description: 'The list of Data Action IDs '
        items:
          type: string
      actionCategoryName:
        type: string
        description: Deprecated - Please use integrationIds instead
      integrationIds:
        type: array
        description: The list of integration IDs for Data Action
        items:
          type: string
      responseStatuses:
        type: array
        description: The list of Response codes for Data Action
        items:
          type: string
      availableDashboard:
        type: string
        description: Filter to indicate the availability of the dashboard is public or private.
        enum:
        - Public
        - Private
      favouriteDashboard:
        type: boolean
        description: Filter to indicate whether the dashboard is favorite or unfavorite.
      myDashboard:
        type: boolean
        description: Filter to indicate the dashboard owned by the user.
      stationErrors:
        type: array
        description: The list of agent errors that are related to station
        items:
          type: string
      canonicalContactIds:
        type: array
        description: The canonical contact ids are used to filter the view
        items:
          type: string
      alertRuleIds:
        type: array
        description: The list of Alert Rule IDs
        items:
          type: string
      evaluationFormContextIds:
        type: array
        description: The list of Evaluation Form Context IDs
        items:
          type: string
      evaluationStatuses:
        type: array
        description: The evaluation statuses that are used to filter the view
        items:
          type: string
          enum:
          - Finished
          - InProgress
          - InReview
          - Pending
          - Retracted
      workbinIds:
        type: array
        description: The list of Workbin IDs
        items:
          type: string
      worktypeIds:
        type: array
        description: The list of Worktype IDs
        items:
          type: string
      workitemIds:
        type: array
        description: The list of Workitem IDs
        items:
          type: string
      workitemAssigneeIds:
        type: array
        description: The list of Workitem Assignee IDs
        items:
          type: string
      workitemStatuses:
        type: array
        description: The list of Workitem Statuses IDs
        items:
          type: string
      isAnalyzedForSensitiveData:
        type: boolean
        description: Deprecated - Use hasPciData or hasPiiData instead.
      hasSensitiveData:
        type: boolean
        description: Deprecated. Use hasPciData or hasPiiData instead.
      hasPciData:
        type: boolean
        description: Filter to indicate the transcript contains Pci data.
      hasPiiData:
        type: boolean
        description: Filter to indicate the transcript contains Pii data.
      subPath:
        type: string
        description: Filter for Sub Path
      userState:
        type: string
        description: The user supplied state value in the view
        enum:
        - ActiveAndInactive
        - Active
        - Inactive
        - Deleted
      isClearedByCustomer:
        type: boolean
        description: Filter to indicate if the customer cleared the conversation.
      evaluationAssigneeIds:
        type: array
        description: The evaluation assignee ids that are used to filter the view.
        items:
          type: string
      evaluationAssigned:
        type: boolean
        description: Filter to indicate that the user has no assigned evaluation.
      assistantIds:
        type: array
        description: The assistant ids that are used to filter the view.
        items:
          type: string
      knowledgeBaseIds:
        type: array
        description: The knowledge base ids that are used to filter the view.
        items:
          type: string
      isParked:
        type: boolean
        description: Filter to indicate if the interactions are parked.
      agentEmpathyScore:
        description: The agentEmpathyScore is used to filter the view
        $ref: '#/definitions/NumericRange'
      surveyTypes:
        type: array
        description: The surveyTypes is used to filter the view
        items:
          type: string
          enum:
          - Web
          - Voice
      surveyResponseStatuses:
        type: array
        description: The list of Survey Response Status
        items:
          type: string
          enum:
          - Unknown
          - FullResponse
          - PartialResponse
      botFlowTypes:
        type: array
        description: The botFlowTypes is used to filter the view
        items:
          type: string
          enum:
          - Unknown
          - Bot
          - DigitalBot
          - VoiceSurvey
      agentTalkDurationMilliseconds:
        type: array
        description: The agent talk durations in milliseconds used to filter the view
        items:
          $ref: '#/definitions/NumericRange'
      customerTalkDurationMilliseconds:
        type: array
        description: The customer talk durations in milliseconds used to filter the view
        items:
          $ref: '#/definitions/NumericRange'
      overtalkDurationMilliseconds:
        type: array
        description: The overtalk durations in milliseconds used to filter the view
        items:
          $ref: '#/definitions/NumericRange'
      silenceDurationMilliseconds:
        type: array
        description: The silence durations in milliseconds used to filter the view
        items:
          $ref: '#/definitions/NumericRange'
      acdDurationMilliseconds:
        type: array
        description: The acd durations in milliseconds used to filter the view
        items:
          $ref: '#/definitions/NumericRange'
      ivrDurationMilliseconds:
        type: array
        description: The ivr durations in milliseconds used to filter the view
        items:
          $ref: '#/definitions/NumericRange'
      otherDurationMilliseconds:
        type: array
        description: The other (hold/music) durations in milliseconds used to filter the view
        items:
          $ref: '#/definitions/NumericRange'
      agentTalkPercentage:
        description: The agent talk percentage used to filter the view
        $ref: '#/definitions/NumericRange'
      customerTalkPercentage:
        description: The customer talk percentage used to filter the view
        $ref: '#/definitions/NumericRange'
      overtalkPercentage:
        description: The overtalk percentage used to filter the view
        $ref: '#/definitions/NumericRange'
      silencePercentage:
        description: The silence percentage used to filter the view
        $ref: '#/definitions/NumericRange'
      acdPercentage:
        description: The acd percentage used to filter the view
        $ref: '#/definitions/NumericRange'
      ivrPercentage:
        description: The ivr percentage used to filter the view
        $ref: '#/definitions/NumericRange'
      otherPercentage:
        description: The other (hold/music percentage used to filter the view
        $ref: '#/definitions/NumericRange'
      overtalkInstances:
        description: The overtalk instance range used to filter the view
        $ref: '#/definitions/NumericRange'
      isScreenRecorded:
        type: boolean
        description: Filter to indicate if the screen is recorded
      screenMonitorUserIds:
        type: array
        description: The list of Screen Monitor User Ids
        items:
          type: string
      dashboardState:
        type: string
        description: The state of dashboard being filtered
        enum:
        - Active
        - Deleted
      dashboardType:
        type: string
        description: The type of dashboard being filtered
        enum:
        - All
        - Public
        - Private
        - Shared
        - Favorites
      dashboardAccessFilter:
        type: string
        description: The type of dashboard access being filtered
        enum:
        - OwnedByMe
        - OwnedByAnyone
        - NotOwnedByMe
      transcriptDurationMilliseconds:
        type: array
        description: The transcript durations in milliseconds used to filter the view
        items:
          $ref: '#/definitions/NumericRange'
      workitemsStatuses:
        type: array
        description: The list of workitem status with worktype
        items:
          $ref: '#/definitions/WorkitemStatusFilter'
      socialCountries:
        type: array
        description: List of countries for social filtering
        items:
          type: string
      socialLanguages:
        type: array
        description: List of languages for social filtering
        items:
          type: string
      socialChannels:
        type: array
        description: List of channels for social filtering
        items:
          type: string
          enum:
          - Twitter
          - Facebook
          - Instagram
          - Open
          - GoogleBusinessProfile
      socialSentimentCategory:
        type: array
        description: The sentiment of the social post
        items:
          type: string
          enum:
          - Positive
          - Negative
          - Neutral
          - Unknown
      socialTopicIds:
        type: array
        description: The list of topicIds for social filtering
        items:
          type: string
      socialIngestionRuleIds:
        type: array
        description: The list of ingestion ruleIds for social filtering
        items:
          type: string
      socialConversationCreated:
        type: boolean
        description: Filter to indicate if the post has created a conversation
      socialContentType:
        type: array
        description: The list of content Type for social filtering
        items:
          type: string
          enum:
          - Text
          - Image
          - Video
      socialKeywords:
        type: array
        description: The list of keywords for social filtering
        items:
          $ref: '#/definitions/SocialKeyword'
      socialPostEscalated:
        type: boolean
        description: Filter to indicate if the post is escalated
      socialClassifications:
        type: array
        description: Indicates if a social message was public or private
        items:
          type: string
          enum:
          - Public
          - Private
      filterUsersByManagerIds:
        type: array
        description: The manager ids used to fetch associated users for the view
        items:
          type: string
      slideshowIds:
        type: array
        description: List of Dashboard slideshowIds to be filtered
        items:
          type: string
      conferenced:
        type: boolean
        description: Filter to indicate if the conversation has conference
      video:
        type: boolean
        description: Filter to indicate if the conversation has video
      linkedInteraction:
        type: boolean
        description: Filter to indicate if the conversation has linked interaction
      recommendationSources:
        type: array
        description: List of recommendation sources for filtering recommendation details pane
        items:
          type: string
          enum:
          - KnowledgeSearch
          - RulesEngine
          - ManualSearch
      evaluationRole:
        type: string
        description: Sets the role when viewing agent evaluations
        enum:
        - Evaluator
        - Supervisor
      comparisonQueueIds:
        type: array
        description: The queue ids are used to for comparison to the primary queue filter in reporting
        items:
          type: string
        x-genesys-entity-type:
          value: QUEUE_ID
      viewMetrics:
        type: array
        description: A list of metrics selected for the view
        items:
          type: string
          enum:
          - AVG_TALK_TIME
          - AVG_HOLD_TIME
          - AVG_ACW_TIME
          - AVG_WAIT_TIME
          - AVG_HANDLE_TIME
          - AVG_ALERT_TIME
          - AVG_ANSWER_TIME
          - AVG_ABANDON_TIME
          - TOTAL_TALK_TIME
          - TOTAL_HANDLE_TIME
          - TOTAL_HOLD_TIME
          - TOTAL_ACW_TIME
          - TOTAL_ALERT_TIME
          - MAX_ABANDON_TIME
          - MAX_WAIT_TIME
          - MAX_TALK_TIME
          - MAX_HOLD_TIME
          - MAX_ACW_TIME
          - MIN_ABANDON_TIME
          - MIN_WAIT_TIME
          - MIN_TALK_TIME
          - MIN_HOLD_TIME
          - MIN_ACW_TIME
          - ALERT_COUNT
          - OFFERED_COUNT
          - ABANDONED_COUNT
          - ABANDONED_PERCENT
          - SHORT_ABANDONED_COUNT
          - SHORT_ABANDONED_PERCENT
          - ABANDONED_NO_SHORT_COUNT
          - ABANDONED_NO_SHORT_PERCENT
          - ANSWERED_COUNT
          - ANSWERED_PERCENT
          - FLOWOUT_COUNT
          - FLOWOUT_PERCENT
          - OUTBOUND_COUNT
          - OUTBOUND_ATTEMPTED_COUNT
          - VOICEMAIL_COUNT
          - HANDLED_COUNT
          - HELD_COUNT
          - TRANSFERRED_COUNT
          - TRANSFERRED_PERCENT
          - WAITING_CURRENT
          - INTERACTING_CURRENT
          - HELD_CURRENT
          - ALERTING_CURRENT
          - SERVICE_LEVEL
          - OVER_SERVICE_LEVEL
          - ONLINE_AGENTS
          - AVAILABLE_AGENTS
          - AWAY_AGENTS
          - BREAK_AGENTS
          - MEAL_AGENTS
          - TRAINING_AGENTS
          - BUSY_AGENTS
          - MEETING_AGENTS
          - SYSTEM_AWAY_AGENTS
          - OFFLINE_AGENTS
          - ON_QUEUE_AGENTS
          - OFF_QUEUE_AGENTS
          - INTERACTING_AGENTS
          - ACW_AGENTS
          - COMMUNICATING_AGENTS
          - IDLE_AGENTS
          - NOT_RESPONDING_AGENTS
          - LONGEST_WAITING
          - LONGEST_INTERACTING
          - FLOW_ACTIVE_LONGEST
          - FLOW_ACTIVE_CURRENT
          - FLOW_ENTRIES_COUNT
          - FLOW_TOTAL_DURATION
          - FLOW_MAX_DURATION
          - FLOW_AVG_DURATION
          - FLOW_DISCONNECT_COUNT
          - FLOW_DISCONNECT_PERCENT
          - FLOW_TOTAL_DISCONNECT_DURATION
          - FLOW_AVG_DISCONNECT_DURATION
          - FLOW_MAX_DISCONNECT_DURATION
          - FLOW_FLOW_DISCONNECT
          - FLOW_FLOW_DISCONNECT_PERCENT
          - FLOW_SYSTEM_ERROR_DISCONNECT
          - FLOW_SYSTEM_ERROR_DISCONNECT_PERCENT
          - FLOW_CUSTOMER_DISCONNECT
          - FLOW_CUSTOMER_DISCONNECT_PERCENT
          - FLOW_SHORT_DISCONNECT
          - FLOW_SHORT_DISCONNECT_PERCENT
          - FLOW_EXIT_COUNT
          - FLOW_EXIT_PERCENT
          - FLOW_TOTAL_EXIT_DURATION
          - FLOW_MAX_EXIT_DURATION
          - FLOW_AVG_EXIT_DURATION
          - FLOW_ACD_EXIT_COUNT
          - FLOW_ACD_EXIT_PERCENT
          - FLOW_GROUP_EXIT_COUNT
          - FLOW_GROUP_EXIT_PERCENT
          - FLOW_NUMBER_EXIT_COUNT
          - FLOW_NUMBER_EXIT_PERCENT
          - FLOW_USER_EXIT_COUNT
          - FLOW_USER_EXIT_PERCENT
          - FLOW_FLOW_EXIT_COUNT
          - FLOW_FLOW_EXIT_PERCENT
          - FLOW_SECURE_FLOW_EXIT_COUNT
          - FLOW_SECURE_FLOW_EXIT_PERCENT
          - FLOW_ACD_VOICEMAIL_EXIT_COUNT
          - FLOW_ACD_VOICEMAIL_EXIT_PERCENT
          - FLOW_USER_VOICEMAIL_EXIT_COUNT
          - FLOW_USER_VOICEMAIL_EXIT_PERCENT
          - FLOW_OUTCOME_COUNT
          - FLOW_AVG_OUTCOME_DECIMAL
          - FLOW_OUTCOME_FAILURE_COUNT
          - FLOW_OUTCOME_FAILURE_PERCENT
          - FLOW_OUTCOME_SUCCESS_COUNT
          - FLOW_OUTCOME_SUCCESS_PERCENT
          - FLOW_OUTCOME_TOTAL_DURATION
          - FLOW_OUTCOME_MAX_DURATION
          - FLOW_OUTCOME_AVG_DURATION
          - FLOW_OUTCOME_MIN_DURATION
          - OFF_QUEUE_TIME
          - OFF_QUEUE_PERCENT
          - AVAILABLE_TIME
          - AVAILABLE_PERCENT
          - BUSY_TIME
          - BUSY_PERCENT
          - AWAY_TIME
          - AWAY_PERCENT
          - BREAK_TIME
          - BREAK_PERCENT
          - MEAL_TIME
          - MEAL_PERCENT
          - MEETING_TIME
          - MEETING_PERCENT
          - TRAINING_TIME
          - TRAINING_PERCENT
          - INTERACTING_TIME
          - INTERACTING_PERCENT
          - COMMUNICATING_TIME
          - COMMUNICATING_PERCENT
          - SYSTEM_AWAY_TIME
          - SYSTEM_AWAY_PERCENT
          - ON_QUEUE_TIME
          - ON_QUEUE_PERCENT
          - IDLE_TIME
          - IDLE_PERCENT
          - NOT_RESPONDING_TIME
          - NOT_RESPONDING_PERCENT
          - LOGGED_IN_TIME
          - OCCUPANCY_PERCENT
          - MIN_ALERT_TIME
          - MAX_ALERT_TIME
          - MIN_HANDLE_TIME
          - MAX_HANDLE_TIME
          - MIN_ANSWERED_TIME
          - MAX_ANSWERED_TIME
          - MIN_NOT_RESPONDING_TIME
          - MAX_NOT_RESPONDING_TIME
          - MET_SERVICE_LEVEL
          - WFM_ADHERENCE_STATUS
          - WFM_SCHEDULED_ACTIVITY
          - WFM_ADHERENCE_DURATION
          - AGENT_TITLE
          - AGENT_DEPARTMENT
          - AGENT_EXTENSION
          - AGENT_SKILLS
          - AGENT_LOCATION
          - AGENT_REPORTS_TO
          - AGENT_EMAIL
          - AGENT_ROLE
          - AGENT_GROUP
          - AGENT_TIME_IN_STATUS
          - AGENT_TIME_IN_ROUTING_STATUS
          - AGENT_STATUS
          - AGENT_SECONDARY_STATUS
          - AGENT_ROUTING_STATUS
          - AGENT_MEDIA_TYPES
          - ACW_COUNT
          - ANSWER_TRANSFERRED_PERCENT
          - FLOW_AVG_MILESTONE_DECIMAL
          - NOT_RESPONDING_COUNT
          - AVG_ACW_HANDLED
          - AVG_CONTACTING_TIME
          - AVG_DIALING_TIME
          - AVG_FLOWOUT_TIME
          - AVG_HOLD_HANDLED
          - AVG_MONITOR
          - BLIND_TRANSFER_COUNT
          - BLIND_TRANSFER_PERCENT
          - CONNECTED_COUNT
          - CONSULT_COUNT
          - CONSULT_TRANSFER_COUNT
          - CONSULT_TRANSFER_PERCENT
          - CONTACTING_COUNT
          - DIALING_COUNT
          - ERROR_COUNT
          - EXTERNAL_MEDIA_COUNT
          - MAX_CONTACTING_TIME
          - MAX_DIALING_TIME
          - MAX_FLOWOUT_TIME
          - FLOW_MILESTONE_COUNT
          - MIN_FLOWOUT_TIME
          - MAX_MONITOR
          - MIN_CONTACTING_TIME
          - MIN_DIALING_TIME
          - MIN_MONITOR
          - MONITOR_COUNT
          - MEDIA_COUNT
          - SERVICE_LEVEL_TARGET
          - SERVICE_LEVEL_TARGET_CURRENT
          - TALK_COUNT
          - TOTAL_ABANDON_TIME
          - TOTAL_NOT_RESPONDING_TIME
          - TOTAL_CONTACTING
          - TOTAL_DIALING
          - TOTAL_MONITOR
          - TOTAL_WAIT_TIME
          - WAIT_COUNT
          - PARK_COUNT
          - AVG_PARK_TIME
          - TOTAL_PARK_TIME
          - MIN_PARK_TIME
          - MAX_PARK_TIME
          - INBOUND_AUDIO_COUNT
          - OUTBOUND_AUDIO_COUNT
      timelineCategories:
        type: array
        description: A list of timeline categories
        items:
          type: string
      acw:
        type: boolean
        description: Filter to indicate for acw state
      segmentTypes:
        type: array
        description: A list of filtered segment types
        items:
          type: string
          enum:
          - alert
          - barging
          - callback
          - coaching
          - contacting
          - converting
          - delay
          - dialing
          - hold
          - interact
          - ivr
          - monitoring
          - parked
          - scheduled
          - screenmonitoring
          - sharing
          - system
          - transmitting
          - unknown
          - uploading
          - voicemail
          - wrapup
      programIds:
        type: array
        description: A list of program ids for filtering
        items:
          type: string
      categoryIds:
        type: array
        description: A list of category ids for filtering
        items:
          type: string
      deliveryPushed:
        type: boolean
        description: Filter to indicate if push notification is sent
      socialRatings:
        type: array
        description: A set of ratings for Google Business Profile
        uniqueItems: true
        items:
          type: number
          format: float
      virtualAgentIds:
        type: array
        description: A list of virtual agent ids for filtering.
        items:
          type: string
      empathyScoreCategories:
        type: array
        description: A set of Empathy Score Categories for filtering
        uniqueItems: true
        items:
          type: string
          enum:
          - Unhelpful
          - Neutral
          - Empathetic
      sentimentScoreCategories:
        type: array
        description: A set of Sentiment Score Categories  for filtering
        uniqueItems: true
        items:
          type: string
          enum:
          - VeryNegative
          - SlightlyNegative
          - Neutral
          - SlightlyPositive
          - VeryPositive
      sentimentTrendCategories:
        type: array
        description: A set of Sentiment Trend Categories for filtering
        uniqueItems: true
        items:
          type: string
          enum:
          - Declining
          - SlightlyDeclining
          - NoChange
          - SlightlyImproving
          - Improving
      contentModerationFlags:
        type: array
        description: A set of Content Moderation Flags for filtering
        uniqueItems: true
        items:
          type: string
          enum:
          - NotSafeForWork
          - SafeForWork
          - Unknown
      socialSourceTypes:
        type: array
        description: A set of Source Types for social filtering
        uniqueItems: true
        items:
          type: string
          enum:
          - Owned
          - NonOwned
          - Others
      socialFollowerRange:
        description: The follower range used to filter the view
        $ref: '#/definitions/SocialNumericRange'
      socialVerificationStatus:
        type: boolean
        description: Filter to indicate if the posts from verified user
      sessionExpired:
        type: boolean
        description: Filter to indicate for if session is expired
      screenMonitored:
        type: boolean
        description: Filter to indicate if the interaction was screen monitored
      engagementSources:
        type: array
        description: The engagement sources used to filter the view
        items:
          type: string
          enum:
          - AppleMessagesForBusiness
          - Discord
          - Email
          - Facebook
          - FacebookMessenger
          - Glassdoor
          - GoogleBusinessProfile
          - Instagram
          - KakaoTalk
          - Line
          - LinkedIn
          - MicrosoftTeams
          - MobileChat
          - Other
          - QQ
          - Reddit
          - ServiceNow
          - SFDC
          - SMS
          - Snapchat
          - Telegram
          - Threads
          - Trustpilot
          - Unspecified
          - Viber
          - WebChat
          - WeChat
          - Weibo
          - WhatsApp
          - X
          - Yelp
          - YouTube
          - Zendesk
          - OpenMessaging
      isSnippetRecorded:
        type: boolean
        description: Indicates filtering for snippet recorded
      takeover:
        type: boolean
        description: Indicates filtering for takeover
      socialPostTypes:
        type: array
        description: The social post types used to filter the view
        uniqueItems: true
        items:
          type: string
          enum:
          - Posts
          - Comments
          - PostMention
          - ReelsMention
          - CommentMention
          - CollaboratePosts
          - LiveVideo
          - LiveComment
          - Reviews
  UserActivityResponse:
    type: object
    properties:
      results:
        type: array
        description: Query results
        items:
          $ref: '#/definitions/UserActivityData'
      entityIdDimension:
        type: string
        description: Dimension that is used as an entityId
        enum:
        - organizationPresenceId
        - presenceDate
        - queueId
        - queueMembershipStatus
        - routingStatus
        - routingStatusDate
        - systemPresence
        - teamId
        - userId
  JourneyAsyncAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - containsAllCondition
          - containsAnyCondition
          - endsWithCondition
          - equalCondition
          - journeyActionId
          - journeyActionMapId
          - journeyActionMapVersion
          - journeyActionMediaType
          - journeyActionTargetId
          - journeyActionTemplateId
          - journeyBlockingActionMapId
          - journeyBlockingEmergencyScheduleGroupId
          - journeyBlockingReason
          - journeyBlockingScheduleGroupId
          - journeyDeviceCategory
          - journeyDeviceType
          - journeyFrequencyCapReason
          - journeyIpGeolocationCountry
          - journeyOutcomeId
          - journeySegmentAssignmentState
          - journeySegmentId
          - journeySessionId
          - journeySessionSegmentId
          - journeySessionType
          - notContainsAllCondition
          - notContainsAnyCondition
          - notEqualCondition
          - startsWithCondition
          - touchpointActionMapId
          - touchpointAgentId
          - touchpointAttributionScope
          - touchpointChannelMessageType
          - touchpointChannelPlatform
          - touchpointChannelType
          - touchpointConversationId
          - touchpointInteractionType
          - touchpointQueueId
          - touchpointRequestedRouting
          - touchpointUsedRouting
          - touchpointWrapupCode
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/JourneyAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nDistinctJourneyActions
          - nDistinctJourneySessions
          - nJourneyActionsBlocked
          - nJourneyOutcomesAchieved
          - nJourneyOutcomesAttributed
          - nJourneySegmentsAssigned
          - nJourneySessions
          - nWebActionsAbandoned
          - nWebActionsAccepted
          - nWebActionsEngaged
          - nWebActionsErrored
          - nWebActionsFrequencyCapReached
          - nWebActionsIgnored
          - nWebActionsOffered
          - nWebActionsOfferedOutsideSchedule
          - nWebActionsQualified
          - nWebActionsQualifiedOutsideSchedule
          - nWebActionsRejected
          - nWebActionsStarted
          - nWebActionsTimedout
          - oJourneyOutcomeTouchpointValue
          - oJourneyOutcomeValue
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/JourneyAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
      pageSize:
        type: integer
        format: int32
        description: The number of results per page
  AnalyticsAgentGroup:
    type: object
    properties:
      agentGroupId:
        type: string
        description: Conditional group routing agent group identifier
      agentGroupType:
        type: string
        description: Conditional group routing agent group type
        enum:
        - Group
        - SkillGroup
        - Team
  TranscriptAggregationSort:
    type: object
    required:
    - function
    - name
    properties:
      name:
        type: string
        description: Name of the metric used for sorting values.
        enum:
        - nSpeechTextAnalyzedConversations
        - nTopicCommunications
        - oCustomerSentiment
        - oOverTalkSpeechInstances
        - oSentimentScore
        - tAgentSpeech
        - tCustomerSpeech
        - tOtherAudio
        - tOverTalkSpeech
        - tSilence
        - tTotalSpeechAndSilence
      function:
        type: string
        description: Aggregation function used for the sort metric.
        enum:
        - average
        - count
        - max
        - min
        - sum
  AgentStateSessionQueryPredicate:
    type: object
    required:
    - dimension
    - value
    properties:
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - mediaType
        - originatingDirection
        - requestedLanguageId
        - requestedRoutingSkillId
        - routedQueueId
        - segmentType
      value:
        type: string
        description: Right hand side for dimension predicates
  AgentStateIsOutOfOfficeCount:
    type: object
    properties:
      isOutOfOffice:
        type: boolean
        description: The out of office state
      count:
        type: integer
        format: int32
        description: Count of users with this out of office state
  TeamActivityQueryMetric:
    type: object
    required:
    - metric
    properties:
      metric:
        type: string
        description: The requested metric
        enum:
        - oTeamOffQueueUsers
        - oTeamOnQueueUsers
        - oTeamPresences
        - oTeamRoutingStatuses
      details:
        type: boolean
        description: Flag for including observation details for this metric in the response
  CaseManagementAggregateDataContainer:
    type: object
    properties:
      group:
        type: object
        description: A mapping from dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        items:
          $ref: '#/definitions/StatisticalResponse'
  UserAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
        x-genesys-entity-type:
          value: INTERVAL
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - userId
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/UserAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - tAgentRoutingStatus
          - tOrganizationPresence
          - tSystemPresence
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/UserAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
  SurveyDetailQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - eventTime
        - queueId
        - surveyCompletedDate
        - surveyFormContextId
        - surveyFormId
        - surveyId
        - surveyPartialResponse
        - surveyPromoterScore
        - surveyStatus
        - surveyType
        - userId
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      metric:
        type: string
        description: Left hand side for metric predicates
        enum:
        - oSurveyTotalScore
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension or metric predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension or metric predicates
        $ref: '#/definitions/NumericRange'
  AggregateMetricData:
    type: object
    properties:
      metric:
        type: string
      qualifier:
        type: string
      stats:
        $ref: '#/definitions/StatisticalSummary'
  FlowAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
        x-genesys-entity-type:
          value: INTERVAL
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - activeRouting
          - activeSkillId
          - addressFrom
          - addressTo
          - agentAssistantId
          - agentBullseyeRing
          - agentOwned
          - agentRank
          - agentScore
          - ani
          - assignerId
          - authenticated
          - conversationId
          - conversationInitiator
          - convertedFrom
          - convertedTo
          - customerParticipation
          - deliveryStatus
          - destinationAddress
          - direction
          - disconnectType
          - divisionId
          - dnis
          - edgeId
          - eligibleAgentCount
          - endingLanguage
          - entryReason
          - entryType
          - errorCode
          - exitReason
          - extendedDeliveryStatus
          - externalContactId
          - externalMediaCount
          - externalOrganizationId
          - externalTag
          - firstQueue
          - flaggedReason
          - flowId
          - flowInType
          - flowMilestoneId
          - flowName
          - flowOutType
          - flowOutcome
          - flowOutcomeId
          - flowOutcomeValue
          - flowSubType
          - flowType
          - flowVersion
          - groupId
          - interactionType
          - journeyActionId
          - journeyActionMapId
          - journeyActionMapVersion
          - journeyCustomerId
          - journeyCustomerIdType
          - journeyCustomerSessionId
          - journeyCustomerSessionIdType
          - knowledgeBaseId
          - mediaCount
          - mediaType
          - messageType
          - originatingDirection
          - outboundCampaignId
          - outboundContactId
          - outboundContactListId
          - participantName
          - peerId
          - proposedAgentId
          - provider
          - purpose
          - queueId
          - recognitionFailureReason
          - remote
          - removedSkillId
          - requestedLanguageId
          - requestedRouting
          - requestedRoutingSkillId
          - roomId
          - routingPriority
          - routingRing
          - routingRule
          - routingRuleType
          - scoredAgentId
          - selectedAgentId
          - selectedAgentRank
          - selfServed
          - sessionDnis
          - sessionId
          - skillExpressionId
          - startingLanguage
          - stationId
          - teamId
          - transferTargetAddress
          - transferTargetName
          - transferType
          - usedRouting
          - userId
          - videoPresent
          - waitingInteractionCount
          - wrapUpCode
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/FlowAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nFlow
          - nFlowMilestone
          - nFlowOutcome
          - nFlowOutcomeFailed
          - oFlowMilestone
          - tFlow
          - tFlowDisconnect
          - tFlowExit
          - tFlowOutcome
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/FlowAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
  SurveyAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
        x-genesys-entity-type:
          value: INTERVAL
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - conversationId
          - divisionId
          - externalContactId
          - mediaType
          - queueId
          - requestedLanguageId
          - requestedRoutingSkillId
          - surveyAnswerId
          - surveyErrorReason
          - surveyFormContextId
          - surveyFormId
          - surveyFormName
          - surveyId
          - surveyPartialResponse
          - surveyPreviousStatus
          - surveyPromoterScore
          - surveyQuestionGroupId
          - surveyQuestionId
          - surveyStatus
          - surveyType
          - teamId
          - userId
          - wrapUpCode
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/SurveyAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nSurveyErrors
          - nSurveyFullResponses
          - nSurveyNpsDetractors
          - nSurveyNpsPromoters
          - nSurveyNpsResponses
          - nSurveyPartialResponses
          - nSurveyQuestionGroupResponses
          - nSurveyQuestionResponses
          - nSurveyResponses
          - nSurveysAbandoned
          - nSurveysDeleted
          - nSurveysExpired
          - nSurveysSent
          - nSurveysStarted
          - nVoiceSurveys
          - nWebSurveys
          - oSurveyQuestionGroupScore
          - oSurveyQuestionScore
          - oSurveyTotalScore
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/SurveyAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
        - surveyCreatedDate
  FlowExecutionAggregateDataContainer:
    type: object
    properties:
      group:
        type: object
        description: A mapping from dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        items:
          $ref: '#/definitions/StatisticalResponse'
  AnalyticsQueryAggregation:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - termFrequency
        - numericRange
      dimension:
        type: string
        description: For use with termFrequency aggregations
      metric:
        type: string
        description: For use with numericRange aggregations
      size:
        type: integer
        format: int32
        description: For use with termFrequency aggregations
      ranges:
        type: array
        description: For use with numericRange aggregations
        items:
          $ref: '#/definitions/AggregationRange'
  TaskManagementAggregateQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/TaskManagementAggregateQueryPredicate'
  SummaryAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
        x-genesys-entity-type:
          value: INTERVAL
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - conversationId
          - copied
          - editedField
          - errorType
          - language
          - mediaType
          - messageType
          - presented
          - queueId
          - summaryGenerated
          - summaryId
          - summaryRating
          - triggerSourceId
          - triggerSourceOutcome
          - triggerSourceType
          - userId
          - wrapUpCodeRating
          - wrapUpCodeSuggestionSelected
          - wrapupCodesGenerated
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/SummaryAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nConversationSummaries
          - nConversationSummaryEngagements
          - tConversationSummary
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/SummaryAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
      queryType:
        type: string
        description: Query type to use. Use groupBy for all matching results, and topN/bottomN for N results ordered by the sortMetric. Default is groupBy.
        enum:
        - bottomN
        - groupBy
        - topN
      sortMetric:
        description: Required when requesting multiple metrics. Only applicable for topN/bottomN query type.
        $ref: '#/definitions/SummaryAggregationSort'
      limit:
        type: integer
        format: int32
        description: How many results you want in an ordered list. Only applicable for topN/bottomN query type.
  SessionEndDetails:
    type: object
    properties:
      type:
        type: string
        description: The type of termination handling that resulted in the session end. It can be either Exit or Disconnect
        enum:
        - Disconnect
        - Exit
      reason:
        type: string
        description: The reason for termination action. It can be due to an error or normal flow execution
  ReportingExportJobListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/ReportingExportJobResponse'
      pageSize:
        type: integer
        format: int32
      pageNumber:
        type: integer
        format: int32
      total:
        type: integer
        format: int64
      firstUri:
        type: string
        format: uri
      nextUri:
        type: string
        format: uri
      previousUri:
        type: string
        format: uri
      lastUri:
        type: string
        format: uri
      selfUri:
        type: string
        format: uri
      pageCount:
        type: integer
        format: int32
  SurveyAsyncAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - conversationId
          - divisionId
          - externalContactId
          - mediaType
          - queueId
          - requestedLanguageId
          - requestedRoutingSkillId
          - surveyAnswerId
          - surveyErrorReason
          - surveyFormContextId
          - surveyFormId
          - surveyFormName
          - surveyId
          - surveyPartialResponse
          - surveyPreviousStatus
          - surveyPromoterScore
          - surveyQuestionGroupId
          - surveyQuestionId
          - surveyStatus
          - surveyType
          - teamId
          - userId
          - wrapUpCode
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/SurveyAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nSurveyErrors
          - nSurveyFullResponses
          - nSurveyNpsDetractors
          - nSurveyNpsPromoters
          - nSurveyNpsResponses
          - nSurveyPartialResponses
          - nSurveyQuestionGroupResponses
          - nSurveyQuestionResponses
          - nSurveyResponses
          - nSurveysAbandoned
          - nSurveysDeleted
          - nSurveysExpired
          - nSurveysSent
          - nSurveysStarted
          - nVoiceSurveys
          - nWebSurveys
          - oSurveyQuestionGroupScore
          - oSurveyQuestionScore
          - oSurveyTotalScore
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/SurveyAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
        - surveyCreatedDate
      pageSize:
        type: integer
        format: int32
        description: The number of results per page
  ReportingExportMetadataJobResponse:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      viewType:
        type: string
        description: The view type of the export metadata
        enum:
        - QUEUE_PERFORMANCE_SUMMARY_VIEW
        - QUEUE_PERFORMANCE_DETAIL_VIEW
        - INTERACTION_SEARCH_VIEW
        - AGENT_PERFORMANCE_SUMMARY_VIEW
        - AGENT_PERFORMANCE_DETAIL_VIEW
        - AGENT_STATUS_SUMMARY_VIEW
        - AGENT_STATUS_DETAIL_VIEW
        - AGENT_EVALUATION_SUMMARY_VIEW
        - AGENT_EVALUATION_DETAIL_VIEW
        - AGENT_QUEUE_DETAIL_VIEW
        - AGENT_INTERACTION_DETAIL_VIEW
        - ABANDON_INSIGHTS_VIEW
        - SKILLS_PERFORMANCE_VIEW
        - SURVEY_FORM_PERFORMANCE_SUMMARY_VIEW
        - SURVEY_FORM_PERFORMANCE_DETAIL_VIEW
        - DNIS_PERFORMANCE_SUMMARY_VIEW
        - DNIS_PERFORMANCE_DETAIL_VIEW
        - WRAP_UP_PERFORMANCE_SUMMARY_VIEW
        - AGENT_WRAP_UP_PERFORMANCE_DETAIL_VIEW
        - QUEUE_ACTIVITY_SUMMARY_VIEW
        - QUEUE_ACTIVITY_DETAIL_VIEW
        - AGENT_QUEUE_ACTIVITY_SUMMARY_VIEW
        - QUEUE_AGENT_DETAIL_VIEW
        - QUEUE_INTERACTION_DETAIL_VIEW
        - AGENT_SCHEDULE_DETAIL_VIEW
        - IVR_PERFORMANCE_SUMMARY_VIEW
        - IVR_PERFORMANCE_DETAIL_VIEW
        - ANSWER_INSIGHTS_VIEW
        - HANDLE_INSIGHTS_VIEW
        - TALK_INSIGHTS_VIEW
        - HOLD_INSIGHTS_VIEW
        - ACW_INSIGHTS_VIEW
        - WAIT_INSIGHTS_VIEW
        - AGENT_WRAP_UP_PERFORMANCE_INTERVAL_DETAIL_VIEW
        - FLOW_OUTCOME_SUMMARY_VIEW
        - FLOW_OUTCOME_PERFORMANCE_DETAIL_VIEW
        - FLOW_OUTCOME_PERFORMANCE_INTERVAL_DETAIL_VIEW
        - FLOW_DESTINATION_SUMMARY_VIEW
        - FLOW_DESTINATION_DETAIL_VIEW
        - API_USAGE_VIEW
        - SCHEDULED_CALLBACKS_VIEW
        - CONTENT_SEARCH_VIEW
        - LANDING_PAGE
        - DASHBOARD_SUMMARY
        - DASHBOARD_DETAIL
        - DASHBOARD_USERS
        - DASHBOARD_USERS_DETAIL
        - JOURNEY_ACTION_MAP_SUMMARY_VIEW
        - JOURNEY_OUTCOME_SUMMARY_VIEW
        - JOURNEY_SEGMENT_SUMMARY_VIEW
        - AGENT_DEVELOPMENT_DETAIL_VIEW
        - AGENT_DEVELOPMENT_DETAIL_ME_VIEW
        - AGENT_DEVELOPMENT_SUMMARY_VIEW
        - AGENT_PERFORMANCE_ME_VIEW
        - AGENT_STATUS_ME_VIEW
        - AGENT_EVALUATION_ME_VIEW
        - AGENT_SCORECARD_VIEW
        - AGENT_SCORECARD_ME_VIEW
        - AGENT_GAMIFICATION_LEADERSHIP_VIEW
        - AGENT_SCHEDULE_ME_VIEW
        - BOT_PERFORMANCE_SUMMARY_VIEW
        - BOT_PERFORMANCE_DETAIL_VIEW
        - SCHEDULED_EXPORTS_VIEW
        - TOPIC_TREND_SUMMARY_VIEW
        - TOPIC_TREND_DETAIL_VIEW
        - ACTION_MAP_BLOCKED_CONSTRAINTS_DETAIL_VIEW
        - ACTION_MAP_BLOCKED_CONSTRAINTS_INTERVAL_DETAIL_VIEW
        - FLOW_MILESTONE_PERFORMANCE_DETAIL_VIEW
        - FLOW_MILESTONE_PERFORMANCE_INTERVAL_DETAIL_VIEW
        - AGENT_TOPIC_SUMMARY_VIEW
        - AGENT_TOPIC_DETAIL_VIEW
        - QUEUE_TOPIC_SUMMARY_VIEW
        - QUEUE_TOPIC_DETAIL_VIEW
        - FLOW_TOPIC_SUMMARY_VIEW
        - FLOW_TOPIC_DETAIL_VIEW
        - AGENT_INTERACTIONS_ME_VIEW
        - ALERT_RULES_VIEW
        - CONFIGURE_ALERT_RULE_VIEW
        - PREDICTIVE_ROUTING_VIEW
        - PREDICTIVE_ROUTING_QUEUE_OVERVIEW
        - PREDICTIVE_ROUTING_MODEL_VIEW
        - PREDICTIVE_ROUTING_IMPACT_VIEW
        - DATA_ACTIONS_PERFORMANCE_SUMMARY_VIEW
        - DATA_ACTIONS_PERFORMANCE_DETAIL_VIEW
        - AGENT_TIMELINE_SUMMARY_VIEW
        - AGENT_TIMELINE_DETAIL_VIEW
        - AGENT_LOGIN_LOGOUT_SUMMARY_VIEW
        - AGENT_LOGIN_LOGOUT_DETAIL_VIEW
        - CAMPAIGN_PERFORMANCE_SUMMARY_VIEW
        - CAMPAIGN_PERFORMANCE_DETAIL_VIEW
        - KNOWLEDGE_PERFORMANCE_VIEW
        - AGENT_SCORECARD_INSIGHTS_SUMMARY_VIEW
        - AGENT_SCORECARD_INSIGHTS_DETAIL_VIEW
        - QUEUE_WRAPUP_DETAIL_VIEW
        - INTERACTION_DETAIL_VIEW
        - CAMPAIGN_INTERACTION_DETAIL_VIEW
        - CAMPAIGN_ATTEMPT_DETAIL_VIEW
        - WORKITEM_PERFORMANCE_SUMMARY_VIEW
        - AGENT_ASSIST_PERFORMANCE_VIEW
        - CONTACT_CENTER_PERFORMANCE_VIEW
        - QUEUE_ROUTING_PERFORMANCE_VIEW
        - AGENT_WORKITEM_PERFORMANCE_SUMMARY_VIEW
        - AGENT_WORKITEM_PERFORMANCE_DETAIL_VIEW
        - QUEUE_WORKITEM_PERFORMANCE_SUMMARY_VIEW
        - QUEUE_WORKITEM_PERFORMANCE_DETAIL_VIEW
        - EMAIL_AGENT_PERFORMANCE_SUMMARY_VIEW
        - EMAIL_AGENT_PERFORMANCE_DETAIL_VIEW
        - MESSAGING_AGENT_PERFORMANCE_SUMMARY_VIEW
        - MESSAGING_AGENT_PERFORMANCE_DETAIL_VIEW
        - EMAIL_QUEUE_PERFORMANCE_SUMMARY_VIEW
        - EMAIL_QUEUE_PERFORMANCE_DETAIL_VIEW
        - MESSAGING_QUEUE_PERFORMANCE_SUMMARY_VIEW
        - MESSAGING_QUEUE_PERFORMANCE_DETAIL_VIEW
        - SOCIAL_LISTENING_VIEW
        - SOCIAL_LISTENING_POSTS_VIEW
        - AGENT_PERFORMANCE_TIMELINE_DETAIL_VIEW
        - DASHBOARD_SLIDESHOWS
        - DASHBOARD_SLIDESHOWS_DETAIL
        - AGENT_COPILOT_PERFORMANCE_VIEW
        - AGENT_ASSIGNED_EVALUATION_ME_VIEW
        - VIRTUAL_AGENT_PERFORMANCE_VIEW
        - CONTENT_EXPLORATION_VIEW
        - EVALUATION_PERFORMANCE_SUMMARY_VIEW
        - EVALUATION_PERFORMANCE_DETAIL_VIEW
        - EVALUATION_PERFORMANCE_QUESTION_GROUP_DETAIL_VIEW
        - EVALUATION_PERFORMANCE_QUESTION_DETAIL_VIEW
        - QUEUE_WORKITEM_ACTIVITY_SUMMARY_VIEW
        - QUEUE_WORKITEM_ACTIVITY_DETAIL_VIEW
        - DIGITAL_ADOPTION_VIEW
        - DIGITAL_INTENT_VIEW
        - DIGITAL_PERFORMANCE_VIEW
        - COPILOT_USAGE_VIEW
        - PREDICTIVE_ROUTING_THROUGHPUT_VIEW
        - QUEUE_SKILL_EXPRESSION_PERFORMANCE_VIEW
        - AGENTIC_VIRTUAL_AGENT_PERFORMANCE_VIEW
        - CALLBACK_QUEUE_PERFORMANCE_SUMMARY_VIEW
        - CALLBACK_QUEUE_PERFORMANCE_DETAIL_VIEW
      dateLimitations:
        type: string
        description: The date limitations of the export metadata
      requiredFilters:
        type: array
        description: The list of required filters for the export metadata
        items:
          type: string
      supportedFilters:
        type: array
        description: The list of supported filters for the export metadata
        items:
          type: string
      requiredColumnIds:
        type: array
        description: The list of required column ids for the export metadata
        items:
          type: string
      dependentColumnIds:
        type: object
        description: The list of dependent column ids for the export metadata
        additionalProperties:
          type: array
          items:
            type: string
      availableColumnIds:
        type: array
        description: The list of available column ids for the export metadata
        items:
          type: string
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  SummaryAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/SummaryAggregateDataContainer'
  AgentCopilotAggregateQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/AgentCopilotAggregateQueryPredicate'
  ReportingTurnKnowledgeFeedbackEvent:
    type: object
    properties:
      searchId:
        type: string
        description: The ID of this knowledge search.
      knowledgeBaseId:
        type: string
        description: The Knowledge Base ID that the captured knowledge data relates to.
      documents:
        type: array
        description: The list of search documents that the feedback applies to.
        items:
          $ref: '#/definitions/ReportingTurnKnowledgeDocument'
      feedbackRating:
        type: integer
        format: int32
        description: The feedback rating for the search (1.0 - 5.0). 1 = Negative, 5 = Positive.
      documentVariationId:
        type: string
        description: The variation of the document.
      documentVersionId:
        type: string
        description: The version of the document.
  TaskManagementAggregateQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - assigneeId
        - caseId
        - divisionId
        - externalTag
        - queueId
        - reporterId
        - requestedLanguageId
        - requestedRouting
        - requestedRoutingSkillId
        - statusCategory
        - statusId
        - typeId
        - usedRouting
        - userId
        - workbinId
        - workitemId
        - wrapUpCode
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension predicates
        $ref: '#/definitions/NumericRange'
  UserAsyncAggregateQueryResponse:
    type: object
    properties:
      systemToOrganizationMappings:
        type: object
        description: A mapping from system presence to a list of organization presence ids
        additionalProperties:
          type: array
          items:
            type: string
      results:
        type: array
        items:
          $ref: '#/definitions/UserAggregateDataContainer'
      cursor:
        type: string
        description: Cursor token to retrieve next page
  FlowActivityQueryMetric:
    type: object
    required:
    - metric
    properties:
      metric:
        type: string
        description: The requested metric
        enum:
        - oFlow
      details:
        type: boolean
        description: Flag for including observation details for this metric in the response
  ActionAggregateQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/ActionAggregateQueryPredicate'
  SegmentDetailQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/SegmentDetailQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/SegmentDetailQueryPredicate'
  ResolutionAsyncAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - conversationId
          - externalContactId
          - mediaType
          - queueId
          - requestedRouting
          - usedRouting
          - userId
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/ResolutionAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nNextContactAvoided
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/ResolutionAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event and choosing "wrapUpDate" uses the date when conversation is ended
        enum:
        - eventTime
        - wrapUpDate
      pageSize:
        type: integer
        format: int32
        description: The number of results per page
  ReportingExportMetadataJobListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/ReportingExportMetadataJobResponse'
      pageSize:
        type: integer
        format: int32
      pageNumber:
        type: integer
        format: int32
      total:
        type: integer
        format: int64
      firstUri:
        type: string
        format: uri
      nextUri:
        type: string
        format: uri
      previousUri:
        type: string
        format: uri
      lastUri:
        type: string
        format: uri
      selfUri:
        type: string
        format: uri
      pageCount:
        type: integer
        format: int32
  KnowledgeAggregationView:
    type: object
    required:
    - function
    - name
    - target
    properties:
      target:
        type: string
        description: Target metric name
        enum:
        - nDistinctKnowledgeSessions
        - nKnowledgeDocumentCopied
        - nKnowledgeDocumentFeedback
        - nKnowledgeDocumentPresented
        - nKnowledgeDocumentSurfaced
        - nKnowledgeDocumentViewed
        - nKnowledgeSearch
        - nKnowledgeSearchAnswered
        - nKnowledgeSearchFeedback
        - nKnowledgeSearchUnanswered
        - nKnowledgeSessions
        - nKnowledgeV3Search
        - oKnowledgeDocumentQuery
        - oKnowledgeDocumentQuerySelfServed
        - oKnowledgeSearch
      name:
        type: string
        description: A unique name for this view. Must be distinct from other views and built-in metric names.
      function:
        type: string
        description: Type of view you wish to create
        enum:
        - rangeBound
      range:
        description: Range of numbers for slicing up data
        $ref: '#/definitions/AggregationRange'
  ActionAggregationView:
    type: object
    required:
    - function
    - name
    - target
    properties:
      target:
        type: string
        description: Target metric name
        enum:
        - tTotalExecution
      name:
        type: string
        description: A unique name for this view. Must be distinct from other views and built-in metric names.
      function:
        type: string
        description: Type of view you wish to create
        enum:
        - rangeBound
      range:
        description: Range of numbers for slicing up data
        $ref: '#/definitions/AggregationRange'
  AnalyticsAgentStateAgentSessionResult:
    type: object
    properties:
      conversationId:
        type: string
        description: Conversation Id
      sessionId:
        type: string
        description: Session Id
      sessionStart:
        type: string
        format: date-time
        description: 'Session start datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      segmentStart:
        type: string
        format: date-time
        description: 'Segment start datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      segmentType:
        type: string
        description: Segment type
        enum:
        - alert
        - barging
        - callback
        - coaching
        - contacting
        - converting
        - delay
        - dialing
        - hold
        - interact
        - ivr
        - monitoring
        - parked
        - scheduled
        - screenmonitoring
        - sharing
        - system
        - transmitting
        - unknown
        - uploading
        - voicemail
        - wrapup
      routedQueueId:
        type: string
        description: Routed queue Id
      requestedRoutingSkillIds:
        type: array
        description: List of requested routing skill Id
        items:
          type: string
      requestedLanguageId:
        type: string
        description: Requested language Id
      originatingDirection:
        type: string
        description: Originating direction
        enum:
        - inbound
        - outbound
      mediaType:
        type: string
        description: Media type
        enum:
        - callback
        - chat
        - cobrowse
        - email
        - internalmessage
        - message
        - screenmonitoring
        - screenshare
        - unknown
        - video
        - voice
  EvaluationDetailQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - assigneeApplicable
        - assigneeId
        - calibrationId
        - contextId
        - deleted
        - evaluationId
        - evaluationStatus
        - evaluatorId
        - eventTime
        - formId
        - formName
        - queueId
        - released
        - rescored
        - systemSubmitted
        - userId
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      metric:
        type: string
        description: Left hand side for metric predicates
        enum:
        - oTotalCriticalScore
        - oTotalScore
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension or metric predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension or metric predicates
        $ref: '#/definitions/NumericRange'
  FlowExecutionAggregationView:
    type: object
    required:
    - function
    - name
    - target
    properties:
      target:
        type: string
        description: Target metric name
        enum:
        - nFlowExecutions
      name:
        type: string
        description: A unique name for this view. Must be distinct from other views and built-in metric names.
      function:
        type: string
        description: Type of view you wish to create
        enum:
        - rangeBound
      range:
        description: Range of numbers for slicing up data
        $ref: '#/definitions/AggregationRange'
  UserDetailQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/UserDetailQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/UserDetailQueryPredicate'
  ConversationAsyncAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - activeRouting
          - activeSkillId
          - addressFrom
          - addressTo
          - agentAssistantId
          - agentBullseyeRing
          - agentOwned
          - agentRank
          - agentScore
          - ani
          - assignerId
          - authenticated
          - conversationId
          - conversationInitiator
          - convertedFrom
          - convertedTo
          - customerParticipation
          - deliveryStatus
          - destinationAddress
          - direction
          - disconnectType
          - divisionId
          - dnis
          - edgeId
          - eligibleAgentCount
          - errorCode
          - extendedDeliveryStatus
          - externalContactId
          - externalMediaCount
          - externalOrganizationId
          - externalTag
          - firstQueue
          - flaggedReason
          - flowInType
          - flowOutType
          - groupId
          - interactionType
          - journeyActionId
          - journeyActionMapId
          - journeyActionMapVersion
          - journeyCustomerId
          - journeyCustomerIdType
          - journeyCustomerSessionId
          - journeyCustomerSessionIdType
          - knowledgeBaseId
          - mediaCount
          - mediaType
          - messageType
          - originatingDirection
          - originatingSocialMediaPublic
          - outboundCampaignId
          - outboundContactId
          - outboundContactListId
          - participantName
          - peerId
          - proposedAgentId
          - provider
          - purpose
          - queueId
          - remote
          - removedSkillId
          - requestedLanguageId
          - requestedRouting
          - requestedRoutingSkillId
          - roomId
          - routingPriority
          - routingRing
          - routingRule
          - routingRuleType
          - scoredAgentId
          - selectedAgentId
          - selectedAgentRank
          - selfServed
          - sessionDnis
          - sessionId
          - skillExpressionId
          - stationId
          - teamId
          - usedRouting
          - userId
          - videoPresent
          - waitingInteractionCount
          - wrapUpCode
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/ConversationAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nBlindTransferred
          - nBotInteractions
          - nCallbackAttempts
          - nCallbackOverSla
          - nCallbackScheduled
          - nCfcOffered
          - nCobrowseSessions
          - nConnected
          - nConsult
          - nConsultTransferred
          - nConversations
          - nError
          - nOffered
          - nOutbound
          - nOutboundAbandoned
          - nOutboundAttempted
          - nOutboundConnected
          - nOverSla
          - nStateTransitionError
          - nTakeover
          - nTransferred
          - oAudioMessageCount
          - oCallbackServiceLevel
          - oExternalAudioMessageCount
          - oExternalMediaCount
          - oMediaCount
          - oMessageCount
          - oMessageSegmentCount
          - oMessageTurn
          - oServiceLevel
          - oServiceTarget
          - oSkillExpressionApplications
          - tAbandon
          - tAcd
          - tActiveCallback
          - tActiveCallbackComplete
          - tAcw
          - tAgentResponseTime
          - tAgentVideoConnected
          - tAlert
          - tAnswered
          - tAverageAgentResponseTime
          - tAverageCustomerResponseTime
          - tBarging
          - tCallbackAbandon
          - tCallbackConnect
          - tCallbackNotReached
          - tCallbackVirtualWait
          - tCfcAbandon
          - tCfcAcd
          - tCfcAnswered
          - tCfcFlowOut
          - tCoaching
          - tCoachingComplete
          - tConnected
          - tContacting
          - tDialing
          - tFirstConnect
          - tFirstDial
          - tFirstEngagement
          - tFirstResponse
          - tFlowOut
          - tHandle
          - tHeld
          - tHeldComplete
          - tIvr
          - tMonitoring
          - tMonitoringComplete
          - tNotResponding
          - tPark
          - tParkComplete
          - tScreenMonitoring
          - tShortAbandon
          - tSnippetRecord
          - tTalk
          - tTalkComplete
          - tTransmitting
          - tUserResponseTime
          - tVoicemail
          - tWait
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/ConversationAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
      queryType:
        type: string
        description: Query type to use. Use groupBy for all matching results, and topN/bottomN for N results ordered by the sortMetric. Default is groupBy.
        enum:
        - bottomN
        - groupBy
        - topN
      sortMetric:
        description: Required when requesting multiple metrics. Only applicable for topN/bottomN query type.
        $ref: '#/definitions/ConversationAggregationSort'
      limit:
        type: integer
        format: int32
        description: How many results you want in an ordered list. Only applicable for topN/bottomN query type.
      pageSize:
        type: integer
        format: int32
        description: The number of results per page
  AgentCopilotAggregationView:
    type: object
    required:
    - function
    - name
    - target
    properties:
      target:
        type: string
        description: Target metric name
        enum:
        - nCannedResponseSuggestions
        - nDistinctConversations
        - nDistinctSuggestions
        - nKnowledgeAnswerSuggestions
        - nKnowledgeArticleSuggestions
        - nKnowledgeSearchSuggestions
        - nScriptSuggestions
      name:
        type: string
        description: A unique name for this view. Must be distinct from other views and built-in metric names.
      function:
        type: string
        description: Type of view you wish to create
        enum:
        - rangeBound
      range:
        description: Range of numbers for slicing up data
        $ref: '#/definitions/AggregationRange'
  ResolutionAggregateQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/ResolutionAggregateQueryPredicate'
  FlowAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/FlowAggregateDataContainer'
  FlowActivityQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/FlowActivityQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/FlowActivityQueryPredicate'
  TaskManagementAggregationView:
    type: object
    required:
    - function
    - name
    - target
    properties:
      target:
        type: string
        description: Target metric name
        enum:
        - nWorkitemsAcdCancelled
        - nWorkitemsAcdExpired
        - nWorkitemsAcdStarted
        - nWorkitemsAgentTransferred
        - nWorkitemsCreated
        - nWorkitemsDeclined
        - nWorkitemsDeleted
        - nWorkitemsDisconnected
        - nWorkitemsOffered
        - nWorkitemsOverSla
        - nWorkitemsPurged
        - nWorkitemsQueueTransferred
        - nWorkitemsStatusChanged
        - nWorkitemsTerminated
        - nWorkitemsTimedout
        - nWorkitemsTransferred
        - nWorkitemsWrapupAdded
        - nWorkitemsWrapupRemoved
        - oWorkitemsServiceLevel
        - tWorkitemsAgentFocusComplete
        - tWorkitemsAlert
        - tWorkitemsAnswered
        - tWorkitemsDirectAnswered
        - tWorkitemsFocus
        - tWorkitemsFocusComplete
        - tWorkitemsHandled
        - tWorkitemsHeld
        - tWorkitemsHeldComplete
        - tWorkitemsNotResponding
        - tWorkitemsParked
        - tWorkitemsQueueAnswered
        - tWorkitemsStatus
      name:
        type: string
        description: A unique name for this view. Must be distinct from other views and built-in metric names.
      function:
        type: string
        description: Type of view you wish to create
        enum:
        - rangeBound
      range:
        description: Range of numbers for slicing up data
        $ref: '#/definitions/AggregationRange'
  AggregationRange:
    type: object
    properties:
      gte:
        type: number
        description: Greater than or equal to
      lt:
        type: number
        description: Less than
  TranscriptAsyncAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/TranscriptAggregateDataContainer'
      cursor:
        type: string
        description: Cursor token to retrieve next page
securityDefinitions:
  PureCloud OAuth:
    type: oauth2
    authorizationUrl: https://login.mypurecloud.com/authorize
    flow: implicit
    scopes:
      all: All the scopes
  Guest Chat JWT:
    type: apiKey
    name: Authorization
    in: header
externalDocs:
  description: PureCloud API Documentation
  url: https://developer.genesys.cloud/