openapi: 3.2.0
info:
  title: bot-api-v2 Current TAR API
  version: '1.1'
servers:
- url: https://{instance}.response.lithium.com/api/v2/bots
  variables:
    instance:
      default: instance
security:
- {}
tags:
- name: CurrentTAR
paths:
  /currentTAR:
    get:
      summary: Get current time to agent response (TAR)
      description: Retrieves the current Time to Agent Response (TAR)
      operationId: currenttar
      parameters:
      - name: timeRangeInMillis
        in: query
        description: (Required) The time range (in milliseconds) to collect TAR data. The time range starts from the time the call is made and runs back to the number of milliseconds passed. This is similar to selecting a Live range in the Analytics UI. Max value is one year (31556952000 milliseconds).
        required: true
        schema:
          type: integer
          format: int64
      - name: priorities
        in: query
        description: A comma-separated list of case priorities used to filter the TAR data. For example, passing '0,1,2' indicates to include only cases with priorities of 0,1, and 2.
        schema:
          type: string
      - name: workqueueIds
        in: query
        description: A comma-separated list of long workqueueIds used to filter the TAR data. For example, passing '1001,1002,2340' filters the data to include only those work queues.
        schema:
          type: string
      - name: responseType
        in: query
        description: 'Response types to query for. Supported values: ''FIRST'' or ''SUBSEQUENT'' (case-insensitive). Omitting the query parameter returns all response types. This query parameters is equivalent to the "Response Type" filter used in the Analytics UI when adding a Response widget to a dashboard.'
        schema:
          type: string
      - name: smartViewId
        in: query
        description: A single smart View ID by which to filter the TAR data.<br/><br/>If the smart view ID passed includes priority and/or work queue definitions, the priorities and work queues defined in the smart view will override values passed with priorities and workqueueIds parameters. <br/><br/>For example, suppose Smart View 102 includes priorities 0 and 5 and work queues 10,11, and, 12. Making a call with timeRangeInMillis=3600000&priorities=1,2,3&workqueueIds=1001,1002,1003&smartViewId=102 will result in data matching the definition defined for Smart View 102 only. The priorities and workqueueIds parameters will be ignored.<br/><br/>On the other hand, if smart view 102 defines a series of tags and has no definitions for priorities or work queues, then that same call would result in matching the tags from smart view 102 and filtering to priorities 1,2, and 3 in work queues 1001,1002, and 1003.
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"status\": \"success\",\n  \"data\": {\n    \"avgTarTimeInMillis\": 1076043325,\n    \"medianTarTimeInMillis\": 5660000\n  }\n}"
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: success
                  data:
                    type: object
                    properties:
                      avgTarTimeInMillis:
                        type: integer
                        example: 1076043325
                        default: 0
                      medianTarTimeInMillis:
                        type: integer
                        example: 5660000
                        default: 0
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - CurrentTAR
x-readme:
  headers: []
  explorer-enabled: false
  proxy-enabled: true
x-readme-fauxas: true