openapi: 3.0.0
info:
  title: VisibilityIQ Application Analytics
  version: 1.2.0
servers:
- url: https://api.zebra.com/v2/data/devices/computers/applications/analytics/visibility
  description: For US
- url: https://api.zebra.com/v2/eu/data/devices/computers/applications/analytics/visibility
  description: For EU
security:
- BearerAuth: []
- ApiKeyAuth: []
paths:
  /usages:
    get:
      tags:
      - Usage
      summary: Retrieves device application inventory and usage information
      description: Retrieves inventory and usage information about applications running
        on devices
      operationId: Retrieve Application Usage
      parameters:
      - name: companyName
        in: header
        description: Company name
        required: true
        schema:
          type: string
      - name: partnerName
        in: header
        description: Partner name
        required: true
        schema:
          type: string
      - name: startDatetime
        in: header
        description: ISO timestamp for the start of the time period in which data
          is retrieved. The startDatetime should be less than endDatetime. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: endDatetime
        in: header
        description: ISO timestamp for the end of the time period in which data is
          fetched. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: offset
        in: query
        description: 'Pagination parameter indicating the starting record position
          for returning the results from the result set.  Any positive value is acceptable.
          An offset bigger than the number of available results will result in an
          error. A negative value will be replaced with 0. Normally, value should
          be 0 or a positive multiple of limit. '
        required: false
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: 'Pagination size indicating the maximum number of results to
          be returned in the response. Valid values are 1 to 20000. Values higher
          than 20000 will be replaced with 20000. Values less than 1 will be replaced
          with 250. '
        required: false
        schema:
          type: integer
          default: 250
      - name: sort
        in: header
        description: "Sort order for the results.  Specified as a JSON object. Currently,\
          \ only one sort order is supported in the criteria even though it is an\
          \ array. Elements other than the first one will be ignored currently.\n\
          \  {\n    \"criteria\": [\n      {\n        \"a\": \"appName\",\n      \
          \  \"o\": \"asc\"\n      }\n    ]\n  } "
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppUsageSortCriteria'
      - name: filter
        in: header
        description: |-
          Filter based on column values.  Numeric value will be filtered by an exact match.  Strings will be filtered by partial matches as well and are case insensitive matches.  The filter criteria are ANDed together. Date filters are also supported, but the value must match  the  format yyyy-MM-dd'T'HH:mm:ss'Z'. Difference between startDatetime and endDatetime should be less than or equal to 30 days. Example
          {
            "appName": "AppXXXllery",
            "appCategory": "UtiXXXX"
          }
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppUsageFilterCriteria'
      responses:
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageApiResponse'
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      deprecated: false
  /device-usages:
    get:
      tags:
      - Devices
      summary: Retrieves inventory and usage information of devices using particular
        application
      description: Retrieves inventory and usage information of devices using particular
        application
      operationId: Retrieve Devices
      parameters:
      - name: companyName
        in: header
        description: Company name
        required: true
        schema:
          type: string
      - name: partnerName
        in: header
        description: Partner name
        required: true
        schema:
          type: string
      - name: appName
        in: header
        description: Application name
        required: true
        schema:
          type: string
      - name: appVersion
        in: header
        description: Application version
        required: false
        schema:
          type: string
      - name: appCategory
        in: header
        description: Application category
        required: false
        schema:
          type: string
          enum:
          - Business
          - Utility
          - Unassigned
          - Non Business
      - name: startDateTime
        in: header
        description: ISO timestamp for the start of the time period in which device
          data is retrieved. startDateTime should be less than end date. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: endDateTime
        in: header
        description: ISO timestamp for the end of the time period in which device
          data is retrieved. The endDateTime should be no more than 30 days after
          the startDateTime.  No more than one month of data is returned. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: offset
        in: query
        description: 'Pagination parameter indicating the starting record position
          for returning the results from the result set.  Any positive value is acceptable.
          An offset bigger than the number of available results will result in an
          error. A negative value will be replaced with 0. Normally, value should
          be 0 or a positive multiple of limit. '
        required: false
        style: form
        explode: true
        schema:
          type: integer
      - name: limit
        in: query
        description: 'Pagination size indicating the maximum number of results to
          be returned in the response. Valid values are 1 to 1000. Values higher than
          1000 will be replaced with 1000. Values less than 1 will be replaced with
          250. '
        required: false
        style: form
        explode: true
        schema:
          type: integer
      - name: sort
        in: header
        description: "Sort order for the results.  Specified as a JSON object.\nCurrently,\
          \ only one sort order is supported in the criteria even though it is an\
          \ array. Elements other than the first one will be ignored currently.\n\
          \  {\n    \"criteria\": [\n      {\n        \"a\": \"totalUsage\",\n   \
          \     \"o\": \"desc\"\n      }\n    ]\n  } "
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppDeviceSortCriteria'
      - name: filter
        in: header
        description: |-
          Filter based on column values.  Numeric value will be filtered by an exact match.  Strings will be filtered by partial matches as well and are case insensitive matches.  The filter criteria are ANDed together. Date filters are also supported, but the value must match the format yyyy-MM-dd'T'HH:mm:ss'Z'. Example
          {
            "serialNum": "12312312312323",
            "model": "TCXXXX"
          }
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppDeviceFilterCriteria'
      responses:
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceApiResponse'
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      deprecated: false
components:
  schemas:
    DateTime:
      type: string
      format: date-time
    Date:
      type: string
      format: date
    AppUsageSortCriteria:
      type: object
      properties:
        criteria:
          type: array
          items:
            type: object
            properties:
              a:
                type: string
                description: Attribute name
                enum:
                - appName
                - appVersion
                - appCategory
                - totalUsage
                - totalDevices
                - totalSites
                - avgUsage
              o:
                type: string
                description: Order for attribute values
                enum:
                - asc
                - desc
    AppUsageFilterCriteria:
      type: object
      properties:
        appVersion:
          type: string
        totalDevices:
          type: integer
        appName:
          type: string
        avgUsage:
          type: integer
        appCategory:
          type: string
        totalUsage:
          type: integer
        totalSites:
          type: integer
    AppDeviceSortCriteria:
      type: object
      properties:
        criteria:
          type: array
          items:
            type: object
            properties:
              a:
                type: string
                description: Attribute name
                enum:
                - model
                - totalUsage
                - serialNum
                - siteName
              o:
                type: string
                description: Order for attribute values
                enum:
                - asc
                - desc
    AppDeviceFilterCriteria:
      type: object
      properties:
        model:
          type: string
        serialNum:
          type: string
        siteName:
          type: string
        siteHierarchy:
          type: string
        totalUsage:
          type: integer
    UsageApiResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/ApiResponseStatus'
        meta:
          $ref: '#/components/schemas/ApiResponseMeta'
        data:
          type: array
          items:
            oneOf:
            - $ref: '#/components/schemas/Usages'
        links:
          $ref: '#/components/schemas/ApiResponseLinks'
    DeviceApiResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/ApiResponseStatus'
        meta:
          $ref: '#/components/schemas/ApiResponseMeta'
        data:
          type: array
          items:
            oneOf:
            - $ref: '#/components/schemas/Devices'
        links:
          $ref: '#/components/schemas/ApiResponseLinks'
    ApiResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/ApiResponseStatus'
        meta:
          $ref: '#/components/schemas/ApiResponseMeta'
        data:
          type: array
          items:
            oneOf:
            - $ref: '#/components/schemas/Devices'
            - $ref: '#/components/schemas/Usages'
        links:
          $ref: '#/components/schemas/ApiResponseLinks'
    ApiError:
      type: object
      properties:
        id:
          type: string
          description: A unique identifier for this particular occurrence of the problem
        links:
          type: object
          properties:
            about:
              type: string
              description: A link that leads to further details about this particular
                occurrence of the problem
          description: Links providing information related to this error
        status:
          type: integer
          description: The HTTP status code applicable to this problem
          format: int32
        code:
          type: string
          description: An application-specific error code, expressed as a string value
        title:
          type: string
          description: A short, human-readable summary of the problem that SHOULD
            NOT change from occurrence to occurrence of the problem, except for purposes
            of localization
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of
            the problem. Like title, this field’s value can be localized
        source:
          type: object
          properties:
            pointer:
              type: string
              description: A JSON Pointer [RFC6901] to the associated entity in the
                request document [e.g. "/data" for a primary data object, or "/data/attributes/title"
                for a specific attribute]
            parameter:
              type: string
              description: A string indicating which URI query parameter caused the
                error
          description: An object containing references to the source of the error
        meta:
          type: object
          description: A meta object containing non-standard meta-information about
            the error
    Usages:
      type: object
      properties:
        appCategory:
          type: string
        appName:
          type: string
        appNameVersion:
          type: string
        appVersion:
          type: string
        avgUsage:
          type: integer
        totalDevices:
          type: integer
        totalUsage:
          type: integer
        totalSites:
          type: integer
      example:
        appCategory: UtiXXXX
        appName: AppXXXXery
        appNameVersion: AppXXXery 3.X.1.X
        appVersion: 3.X.1.X
        avgUsage: 7487
        totalDevices: 2778
        totalUsage: 20798486
        totalSites: 1061
    Devices:
      type: object
      properties:
        model:
          type: string
        serialNum:
          type: string
        siteName:
          type: string
        siteHierarchy:
          type: string
        totalUsage:
          type: integer
      example:
        model: TCXX
        serialNum: "12312312312312"
        siteName: 123 XXXXX XX
        siteHierarchy: US/X - XXXX/STORES/XXX OMXXA
        totalUsage: 11755
    ApiResponseStatus:
      type: integer
      description: The HTTP status code
      format: int32
    ApiResponseMeta:
      type: object
      properties:
        id:
          type: string
          description: A unique identifier for this request
        total:
          type: integer
          description: The total number of results
        offset:
          type: integer
          description: The offset used in this request
        limit:
          type: integer
          description: The effective limit used in this request
    ApiResponseLinks:
      type: object
      properties:
        self:
          type: string
          description: URL to this page
        first:
          type: string
          description: URL to the first page
        last:
          type: string
          description: URL to the last page
        prev:
          type: string
          description: URL to the previous page
        next:
          type: string
          description: URL to the next page
      description: Links for navigation. Only the applicable links are required to
        be present.
  responses:
    Response200:
      description: Successful operation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiResponse'
    Response400:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Response401:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Response500:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  parameters:
    companyName:
      name: companyName
      in: header
      description: Company name
      required: true
      schema:
        type: string
    partnerName:
      name: partnerName
      in: header
      description: Partner name
      required: true
      schema:
        type: string
    startDatetime:
      name: startDatetime
      in: header
      description: ISO timestamp for the start of the time period in which data is
        retrieved. The startDatetime should be less than endDatetime. Example=2020-04-13T00:00:00Z
      required: true
      schema:
        $ref: '#/components/schemas/DateTime'
    endDatetime:
      name: endDatetime
      in: header
      description: ISO timestamp for the end of the time period in which data is fetched.
        Example=2020-04-13T00:00:00Z
      required: true
      schema:
        $ref: '#/components/schemas/DateTime'
    offset:
      name: offset
      in: query
      description: 'Pagination parameter indicating the starting record position for
        returning the results from the result set.  Any positive value is acceptable.
        An offset bigger than the number of available results will result in an error.
        A negative value will be replaced with 0. Normally, value should be 0 or a
        positive multiple of limit. '
      required: false
      schema:
        type: integer
        default: 0
    limit:
      name: limit
      in: query
      description: 'Pagination size indicating the maximum number of results to be
        returned in the response. Valid values are 1 to 20000. Values higher than
        20000 will be replaced with 20000. Values less than 1 will be replaced with
        250. '
      required: false
      schema:
        type: integer
        default: 250
  requestBodies: {}
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
    ApiKeyAuth:
      type: apiKey
      name: X-APIKey
      in: header
  links: {}
  callbacks: {}
