Avaya Dimensions API

openapi: 3.2.0
info:
  title: Analytics - Historical Data v1 Dimensions API
  description: 'The Analytics Historical API exposes the following functionality:

    - Listing the Dimension names for an Account.

    - Retrieving the content of a specified Dimension.

    - Listing the Report names for an Account.

    - Retrieving the content of a specific Report.'
  contact:
    name: Avaya API Team
    url: https://developers.avayacloud.com/onecloud-ccaas
    email: apiteam@avaya.com
  license:
    name: Avaya Software Development Kit (SDK) Software License Terms
    url: http://support.avaya.com/css/P8/documents/101038288
  version: 1.0.1
servers:
- url: '{protocol}://{server}{basePath}'
  description: Open API
  variables:
    protocol:
      enum:
      - https
      default: https
    server:
      default: HOST-REGION.api.avayacloud.com
    basePath:
      default: /api/analytics/historical/v1
- url: '{protocol}://{server}:{port}'
  description: Internal API
  variables:
    protocol:
      enum:
      - http
      - https
      default: http
    server:
      default: analytics-historical-api
    port:
      enum:
      - '80'
      - '443'
      default: '80'
security:
- {}
- BearerAuth: []
  AppKey: []
tags:
- name: Dimensions
  description: A Dimension is a collection of related contact center objects used to provide a view of measurement data.
paths:
  /accounts/{accountId}/dimensions:getNames:
    get:
      tags:
      - Dimensions
      summary: List Dimension Names
      description: Gets the list of dimensions for an Account.
      operationId: listDimensionNames
      parameters:
      - $ref: '#/components/parameters/accountId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DimensionNames'
              examples:
                default:
                  $ref: '#/components/examples/DimensionNames'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                default:
                  $ref: '#/components/examples/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServer'
  /accounts/{accountId}/dimensions/{dimensionName}:
    get:
      tags:
      - Dimensions
      summary: Get Dimension
      description: Gets the list of dimension data for a Dimension name.
      operationId: getDimension
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/dimensionName'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/prevPageToken'
      - $ref: '#/components/parameters/nextPageToken'
      - $ref: '#/components/parameters/filter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DimensionPage'
              examples:
                default:
                  $ref: '#/components/examples/DimensionPage'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                default:
                  $ref: '#/components/examples/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServer'
components:
  examples:
    ErrorForbidden:
      description: Forbidden
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#forbidden
        title: Forbidden
        status: 403
        detail: According to the access control policy the current user and/or accountId does not have permission to access this resource.
    ErrorConstraintViolation:
      description: Constraint Violation
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#constraint-violation
        title: Constraint Violation
        status: 400
        detail: A problem that indicates a syntactically correct, yet semantically illegal request. The Server can not process this request until the client resolves the semantic errors described in the violations section.
        violations:
        - field: accountId
          message: must match "^[a-zA-Z]{6}$"
          code: 20006
    DimensionNames:
      value:
      - agents
      - queues
    DimensionPage:
      value:
        columnHeaders:
        - name: agent_sk
          type: string
        - name: supervisor_sk
          type: string
        - name: agent_id
          type: string
        - name: agent_login_id
          type: string
        - name: agent_first_name
          type: string
        - name: agent_last_name
          type: string
        - name: agent_display_name
          type: string
        - name: agent_user_handle
          type: string
        - name: agent_type
          type: string
        - name: attributes
          type: string
        - name: row_active_date
          type: string
        - name: row_inactive_date
          type: string
        - name: active_record
          type: boolean
        - name: is_unknown
          type: boolean
        - name: entity_deleted
          type: boolean
        - name: last_changed
          type: string
        - name: redacted
          type: boolean
        records:
        - - '2'
          - '-1'
          - '123456'
          - agent@email.com
          - agent
          - '03'
          - agent,03
          - '123456'
          - Supervisor
          - '[{"value": "English", "category": "Language"}]'
          - '2021-09-03 10:15:00+00'
          - '9999-12-31 00:00:00+00'
          - t
          - f
          - f
          - '2021-09-03 10:31:13.066584+00'
          - f
        pagination:
          pageSize: 20
          prevPageToken: ''
          nextPageToken: 123e4567-e89b-12d3-a456-556642440000
        links:
          prev: ''
          next: /api/analytics/historical/v1/accounts/{accountId}/dimensions/agents?filter=agent_id:123456&nextPageToken=123e4567-e89b-12d3-a456-556642440000&pageSize=20
    ErrorNotFound:
      description: Not Found
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#resource-not-found
        title: Resource Not Found
        status: 404
        detail: Resource not found.
    ErrorUnauthorized:
      description: Unauthorized
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#unauthorized
        title: Unauthorized
        status: 401
        detail: This operation requires authentication. See https://developers.avayacloud.com/onecloud-ccaas/docs/how-to-authenticate-with-ccaas-apis
    ErrorInternalServerError:
      description: Server Error
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#server-error
        title: Server Error
        status: 500
        detail: An internal server error was encountered.
  responses:
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorNotFound'
    InternalServer:
      description: Internal Server Error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorInternalServerError'
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorForbidden'
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorUnauthorized'
  parameters:
    accountId:
      name: accountId
      in: path
      description: The unique 6 character internal id that represents the customer account.
      required: true
      schema:
        type: string
        minLength: 6
        maxLength: 6
        pattern: ^[a-zA-Z]{6}$
        example: ABCDEF
    pageSize:
      name: pageSize
      in: query
      description: The maximum number of results per page.
      required: false
      schema:
        type: integer
        format: int32
        default: 20
        minimum: 1
        maximum: 50
        example: 20
    prevPageToken:
      name: prevPageToken
      in: query
      description: The page token of the previous set of records to retrieve, represented as unique 36 characters(uuid).
      required: false
      schema:
        type: string
        minLength: 36
        maxLength: 36
        example: 123e4567-e89b-12d3-a456-556642440000
    dimensionName:
      name: dimensionName
      in: path
      description: The unique name of the dimension
      required: true
      schema:
        type: string
        minLength: 1
        maxLength: 50
        example: queues
    filter:
      name: filter
      in: query
      description: "Specifies details of a row filter. The allowed format:\n  - Begins with the column name to be filtered, followed by a colon, then:\n  - Either an exact string to match, or\n  - A string expression including the * wildcard character\n"
      required: false
      schema:
        type: string
        minLength: 3
        maxLength: 256
      examples:
        equals:
          value: agentLastName:agentKaren
          summary: Exact string to match
        like:
          value: agentLastName:agentK*
          summary: Expression including the * wildcard character
    nextPageToken:
      name: nextPageToken
      in: query
      description: The page token of the next set of records to retrieve, represented as unique 36 characters(uuid).
      required: false
      schema:
        type: string
        minLength: 36
        maxLength: 36
        example: 123e4567-e89b-12d3-a456-556642440000
  schemas:
    Links:
      type: object
      properties:
        prev:
          type: string
          description: URL of the previous page. Blank if currently on the first page.
        next:
          type: string
          description: URL of the next page. Blank if currently on the last page.
    CursorPagination:
      type: object
      properties:
        pageSize:
          type: integer
          description: The max number of records that can be retrieved on this page.
        prevPageToken:
          type: string
          description: The Token to retrieve the prev page of records.
        nextPageToken:
          type: string
          description: The Token to retrieve the next page of records.
    DimensionNames:
      type: array
      description: List of dimension names
      items:
        type: string
    ColumnHeader:
      type: object
      description: Name and data type of the column header
      properties:
        name:
          type: string
          description: Name of the header field
          example: agentFirstName
        type:
          type: string
          description: Data type of the header field
          example: string
    Problem:
      type: object
      description: '<b>Problem Detail</b> as a way to carry machine-readable details of errors in a HTTP response to avoid the need to define new error response formats for HTTP APIs <a href="https://tools.ietf.org/html/rfc7807">RFC 7807</a>

        '
      properties:
        type:
          type: string
          format: uri
          description: 'An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type (e.g., using HTML).

            '
          default: about:blank
          example: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#constraint-violation
        title:
          type:
          - string
          - 'null'
          description: 'A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized).

            '
          example: Service Unavailable
        status:
          type:
          - integer
          - 'null'
          format: int32
          description: 'The HTTP status code generated by the origin server for this occurrence of the problem.

            '
          minimum: 100
          example: 503
          exclusiveMaximum: 600
        detail:
          type:
          - string
          - 'null'
          description: 'A human readable explanation specific to this occurrence of the problem.

            '
          example: Connection to database timed out
        instance:
          type:
          - string
          - 'null'
          format: uri
          description: 'An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

            '
        violations:
          type:
          - array
          - 'null'
          description: 'A list of violations that occurred as a result of invalid data provided as part of a request.

            '
          items:
            type: object
            properties:
              field:
                type: string
                description: 'The name of the field in the request that caused the violation. This can be the name of a path parameter, query parameter, or a field within the request body.

                  '
                example: accountId
              message:
                type: string
                description: 'A human readable explanation specific to this occurrence of the violation.

                  '
                example: must match "^[a-zA-Z]{6}$"
              code:
                type: integer
                format: int32
                description: 'The violation code generated by the server for this occurrence of the violation. Use this code when implementing any error handling logic instead of the message, as the message can change.

                  '
                example: 20006
          example:
          - field: emailAddress
            message: must not be null
            code: 20002
          - field: accountId
            message: must match "^[a-zA-Z]{6}$"
            code: 20006
    DimensionPage:
      type: object
      description: Root response object for dimension http requests.
      properties:
        columnHeaders:
          type: array
          items:
            $ref: '#/components/schemas/ColumnHeader'
        records:
          type: array
          items:
            type: array
            items:
              type: string
        pagination:
          $ref: '#/components/schemas/CursorPagination'
        links:
          $ref: '#/components/schemas/Links'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: This API uses Bearer Token Authorization Flow
      bearerFormat: JWT
    AppKey:
      type: apiKey
      in: header
      name: appkey
      description: This API needs an appKey as header.
x-explorer-enabled: false
x-samples-languages:
- curl
- node
- java
- javascript
- python
- go