openapi: 3.2.0
info:
  title: apps Evaluation API
  version: ''
servers:
- url: https://{tenant}.{region}.qlikcloud.com
  variables:
    region:
      default: us
      description: The region the tenant is hosted in
    tenant:
      default: your-tenant
      description: Name of the tenant that will be called
tags:
- name: Evaluation
paths:
  /api/v1/apps/{guid}/evaluations:
    get:
      tags:
      - Evaluation
      summary: Retrieve a list of all historic evaluations for an app GUID
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/evaluations'
          description: Evaluation(s) retrieved successfully.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluatorError'
          description: Bad request.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluatorError'
          description: Not Found.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluatorError'
          description: Internal server error.
      parameters:
      - in: path
        name: guid
        schema:
          type: string
        example: abcdefghijklmnopq
        required: true
        description: The app guid.
      - in: query
        name: all
        schema:
          type: boolean
        required: false
        description: Get the full data of the evaluation
      - in: query
        name: fileMode
        schema:
          type: boolean
        required: false
        description: Add file transfer headers to response
      - in: query
        name: format
        schema:
          type: string
        required: false
        description: Specify output format, currently supported are 'json' and 'xml'
      - in: query
        name: limit
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 1
        required: false
        description: Number of results to return per page.
      - in: query
        name: next
        schema:
          type: string
        required: false
        description: The app evaluation id to get next page from
      - in: query
        name: prev
        schema:
          type: string
        required: false
        description: The app evaluation id to get previous page from
      - in: query
        name: sort
        schema:
          type: string
        required: false
        description: Property to sort list on
      description: 'Find all evaluations for an app GUID.

        Supports paging via next, prev which are sent in the response body'
      operationId: evaluation#getEvaluations
      x-qlik-stability: stable
      x-qlik-deprecated: true
      x-qlik-visibility: public
      x-qlik-deprecated-sunset: 2026-09
      x-qlik-deprecated-version: 2026-06
      x-qlik-deprecated-description: Replaced by namespaced API
      x-qlik-replaced-by:
      - namespace: analytics
        uniqueIdentifier: GET:/analytics/apps/{guid}/evaluations
      x-qlik-tier:
        tier: '1'
        limit: 1000
    post:
      tags:
      - Evaluation
      summary: Queue an app evaluation
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/evaluation'
          description: App evaluation queued.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluatorError'
          description: Bad request, incorrect body.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluatorError'
          description: User lacks permissions to evaluate app.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluatorError'
          description: App does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluatorError'
          description: Internal server error.
      parameters:
      - in: path
        name: guid
        schema:
          type: string
        example: abcdefghijklmnopq
        required: true
        description: Guid of the app.
      description: Queue an app evaluation by its app guid.
      operationId: evaluation#queueEvaluation
      x-qlik-stability: stable
      x-qlik-deprecated: true
      x-qlik-visibility: public
      x-qlik-deprecated-sunset: 2026-09
      x-qlik-deprecated-version: 2026-06
      x-qlik-deprecated-description: Replaced by namespaced API
      x-qlik-replaced-by:
      - namespace: analytics
        uniqueIdentifier: POST:/analytics/apps/{guid}/evaluations
      x-qlik-tier:
        tier: '2'
        limit: 100
  /api/v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}:
    get:
      tags:
      - Evaluation
      summary: Compare two evaluations
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/comparison'
          description: Comparison executed successfully.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluatorError'
          description: Not Found.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluatorError'
          description: Internal server error.
      parameters:
      - in: path
        name: baseid
        schema:
          type: string
        example: abcdefghijklmnopq
        required: true
        description: Id of the baseline evaluation
      - in: path
        name: comparisonid
        schema:
          type: string
        example: abcdefghijklmnopq
        required: true
        description: Id of the comparison evaluation
      - in: query
        name: all
        schema:
          type: boolean
        required: false
        description: Get the full list of comparisons including non-significant diffs
      - in: query
        name: format
        schema:
          type: string
        required: false
        description: Specify output format, currently supported are 'json' and 'xml'
      description: Accepts two evaluation ids and returns a comparison denoting the differences between the two.
      operationId: evaluation#compareTwo
      x-qlik-stability: stable
      x-qlik-deprecated: true
      x-qlik-visibility: public
      x-qlik-deprecated-sunset: 2026-09
      x-qlik-deprecated-version: 2026-06
      x-qlik-deprecated-description: Replaced by namespaced API
      x-qlik-replaced-by:
      - namespace: analytics
        uniqueIdentifier: GET:/analytics/apps/evaluations/{baselineId}/compare/{comparisonId}
      x-qlik-tier:
        tier: '1'
        limit: 1000
  /api/v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}/actions/download:
    get:
      tags:
      - Evaluation
      summary: Download a comparison log of two evaluations
      responses:
        '200':
          content:
            application/xml: {}
            application/json:
              schema:
                $ref: '#/components/schemas/comparison'
          description: Comparison executed successfully.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluatorError'
          description: Not Found.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluatorError'
          description: Internal server error.
      parameters:
      - in: path
        name: baseid
        schema:
          type: string
        example: abcdefghijklmnopq
        required: true
        description: Id of the baseline evaluation
      - in: path
        name: comparisonid
        schema:
          type: string
        example: abcdefghijklmnopq
        required: true
        description: Id of the comparison evaluation
      description: Accepts two evaluation ids and downloads a log, in XML format, denoting the differences between the two.
      operationId: evaluation#downloadCompareTwo
      x-qlik-stability: stable
      x-qlik-deprecated: true
      x-qlik-visibility: public
      x-qlik-deprecated-sunset: 2026-09
      x-qlik-deprecated-version: 2026-06
      x-qlik-deprecated-description: Replaced by namespaced API
      x-qlik-replaced-by:
      - namespace: analytics
        uniqueIdentifier: GET:/analytics/apps/evaluations/{baselineId}/compare/{comparisonId}/actions/download
      x-qlik-tier:
        tier: '1'
        limit: 1000
  /api/v1/apps/evaluations/{id}:
    get:
      tags:
      - Evaluation
      summary: Retrieve a specific evaluation
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/evaluation'
          description: Evaluation(s) retrieved successfully.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluatorError'
          description: Not Found.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluatorError'
          description: Internal server error.
      parameters:
      - in: path
        name: id
        schema:
          type: string
        example: abcdefghijklmnopq
        required: true
        description: Id of the desired evaluation.
      - in: query
        name: all
        schema:
          type: boolean
        required: false
        description: Get the full data of the evaluation
      - in: query
        name: format
        schema:
          type: string
        required: false
        description: Specify output format, currently supported are 'json' and 'xml'
      description: Find an evaluation by a specific id.
      operationId: evaluation#getOneEvaluation
      x-qlik-stability: stable
      x-qlik-deprecated: true
      x-qlik-visibility: public
      x-qlik-deprecated-sunset: 2026-09
      x-qlik-deprecated-version: 2026-06
      x-qlik-deprecated-description: Replaced by namespaced API
      x-qlik-replaced-by:
      - namespace: analytics
        uniqueIdentifier: GET:/analytics/apps/evaluations/{id}
      x-qlik-tier:
        tier: '1'
        limit: 1000
  /api/v1/apps/evaluations/{id}/actions/download:
    get:
      tags:
      - Evaluation
      summary: Download a detailed XML log of a specific evaluation
      responses:
        '200':
          content:
            application/xml: {}
            application/json:
              schema:
                $ref: '#/components/schemas/evaluation'
          description: Evaluation(s) retrieved successfully.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluatorError'
          description: Not Found.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluatorError'
          description: Internal server error.
      parameters:
      - in: path
        name: id
        schema:
          type: string
        example: abcdefghijklmnopq
        required: true
        description: Id of the desired evaluation.
      description: Find and download an evaluation log by a specific evaluation id.
      operationId: evaluation#downloadOneEvaluation
      x-qlik-stability: stable
      x-qlik-deprecated: true
      x-qlik-visibility: public
      x-qlik-deprecated-sunset: 2026-09
      x-qlik-deprecated-version: 2026-06
      x-qlik-deprecated-description: Replaced by namespaced API
      x-qlik-replaced-by:
      - namespace: analytics
        uniqueIdentifier: GET:/analytics/apps/evaluations/{id}/actions/download
      x-qlik-tier:
        tier: '1'
        limit: 1000
components:
  schemas:
    event:
      type: object
      properties:
        details:
          type: string
          example: An object failed
        sheetId:
          type: string
          example: gregFG
        objectId:
          type: string
          example: adfRFr
        severity:
          type: string
          example: warning
        errorCode:
          type: string
          example: ERR-GOPHERCISER
        objectType:
          type: string
          example: linechart
        sheetTitle:
          type: string
          example: mysheet
        objectTitle:
          type: string
          example: profit
        objectVisualization:
          type: string
          example: linechart
    sortedcomparisonobjresponsetime:
      allOf:
      - type: object
        properties:
          list:
            $ref: '#/components/schemas/comparisonobjresponsetime'
          absoluteDiffAsc:
            $ref: '#/components/schemas/comparisonobjresponsetime'
          relativeDiffAsc:
            $ref: '#/components/schemas/comparisonobjresponsetime'
          absoluteDiffDesc:
            $ref: '#/components/schemas/comparisonobjresponsetime'
          dataSourceStatus:
            enum:
            - full
            - none
            - baselinemissing
            - comparisonmissing
            type: string
            example: full
          relativeDiffDesc:
            $ref: '#/components/schemas/comparisonobjresponsetime'
    comparisonfields:
      type: array
      items:
        allOf:
        - $ref: '#/components/schemas/objecttopspec'
        - type: object
          properties:
            name:
              type: string
              example: a
            cardinal:
              $ref: '#/components/schemas/cmpint'
            byte_size:
              $ref: '#/components/schemas/cmpint'
            is_system:
              $ref: '#/components/schemas/cmpbool'
            total_count:
              $ref: '#/components/schemas/cmpint'
            dataSourceStatus:
              enum:
              - full
              - none
              - baselinemissing
              - comparisonmissing
              type: string
              example: full
    evaluation:
      type: object
      properties:
        id:
          type: string
          format: string
          example: 5ecb5e65028d1f0001a98071
        appId:
          type: string
          format: string
          example: 7c2ce11d-4d10-4414-a9b0-620e57298038
        ended:
          type: string
          format: date-time
          example: '2022-02-09T06:58:40.575Z'
        events:
          type: array
          items:
            $ref: '#/components/schemas/event'
        result:
          $ref: '#/components/schemas/result'
        status:
          type: string
          format: string
          example: finished
        appName:
          type: string
          format: string
          example: my app
        details:
          type: object
          properties:
            errors:
              type: array
              items:
                type: string
                format: string
                example: this is an error
            warnings:
              type: array
              items:
                type: string
                format: string
                example: this is a warning
            dedicated:
              type: boolean
              example: false
              deprecated: true
            objectMetrics:
              type: object
              additionalProperties:
                $ref: '#/components/schemas/resultentry'
            engineHasCache:
              type: boolean
              example: false
            concurrentReload:
              type: boolean
              example: false
        sheetId:
          type: string
          format: string
          example: zyb2bQTeFmPVt9TXZOS0I5GZCFn
        started:
          type: string
          format: date-time
          example: '2022-02-09T06:58:40.575Z'
        version:
          type: number
          example: 1
        metadata:
          $ref: '#/components/schemas/metadata'
        tenantId:
          type: string
          format: string
          example: zyb2bQTeFmPVt9TXZOS0I5GZCFn
        appItemId:
          type: string
          format: string
          example: zyb2bQTeFmPVt9TXZOS0I5GZCFn
        timestamp:
          type: string
          format: date-time
          example: '2022-02-09T06:58:40.575Z'
        sheetTitle:
          type: string
          format: string
          example: my sheet
    cmpfloat:
      allOf:
      - $ref: '#/components/schemas/classification'
      - type: object
        properties:
          baseline:
            type: number
            example: 1.1
          comparison:
            type: number
            example: 2.2
    comparisontables:
      type: array
      items:
        allOf:
        - $ref: '#/components/schemas/objecttopspec'
        - type: object
          properties:
            name:
              type: string
              example: a
            byte_size:
              $ref: '#/components/schemas/cmpint'
            is_system:
              $ref: '#/components/schemas/cmpbool'
            no_of_rows:
              $ref: '#/components/schemas/cmpint'
            dataSourceStatus:
              enum:
              - full
              - none
              - baselinemissing
              - comparisonmissing
              type: string
              example: full
    result:
      type: object
      properties:
        sheets:
          type: array
          items:
            $ref: '#/components/schemas/resultobjsheet'
        rowCount:
          type: number
          example: 20000
        objNoCache:
          type: array
          items:
            $ref: '#/components/schemas/resultobjresponsetime'
        sheetCount:
          type: number
          example: 5
        objectCount:
          type: number
          example: 33
        objSlowCached:
          type: array
          items:
            $ref: '#/components/schemas/resultobjresponsetime'
        objMemoryLimit:
          type: array
          items:
            $ref: '#/components/schemas/resultobjMemoryLimit'
        documentSizeMiB:
          type: number
          example: 12.3
        objSlowUncached:
          type: array
          items:
            $ref: '#/components/schemas/resultobjresponsetime'
        hasSectionAccess:
          type: boolean
          example: false
        topFieldsByBytes:
          type: array
          items:
            $ref: '#/components/schemas/resultmetadatatopfields'
        topTablesByBytes:
          type: array
          items:
            $ref: '#/components/schemas/resultmetadatatoptables'
        objSingleThreaded:
          type: array
          items:
            $ref: '#/components/schemas/resultsingle'
    evaluations:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/evaluation'
        links:
          type: object
          properties:
            next:
              type: object
              properties:
                href:
                  $ref: '#/components/schemas/href'
            prev:
              type: object
              properties:
                href:
                  $ref: '#/components/schemas/href'
    objectspec:
      type: object
      properties:
        id:
          type: string
          format: string
          example: fjETFn
        title:
          type: string
          format: string
          example: my chart
        sheetId:
          type: string
          format: string
          example: 41dbb01c-d1bd-4528-be05-910ee565988b
        objectType:
          type: string
          example: table
    resultobjresponsetime:
      allOf:
      - $ref: '#/components/schemas/objectspec'
      - type: object
        properties:
          timeoutStatusCode:
            type: string
            example: CALC-TIMEOUT
          responseTimeSeconds:
            type: number
            example: 12.3
    href:
      type: string
      example: /api/v1/evaluations/appId=a84c22cf-31e5-41fe-9e8f-544b85513484&prev=5f5201908b3fc5fc132dbd35
    resultobjMemoryLimit:
      allOf:
      - $ref: '#/components/schemas/objectspec'
      - type: object
        properties:
          memoryLimitStatusCode:
            type: string
            example: OUT-OF-MEMORY
    comparisonoobjheavy:
      type: array
      items:
        allOf:
        - $ref: '#/components/schemas/objectspec'
        - type: object
          properties:
            cpuSeconds1:
              $ref: '#/components/schemas/cmpfloat'
            cpuSeconds2:
              $ref: '#/components/schemas/cmpfloat'
            cpuQuotient1:
              $ref: '#/components/schemas/cmpfloat'
            cpuQuotient2:
              $ref: '#/components/schemas/cmpfloat'
            dataSourceStatus:
              enum:
              - full
              - none
              - baselinemissing
              - comparisonmissing
              type: string
              example: full
    cmpbool:
      allOf:
      - $ref: '#/components/schemas/classification'
      - type: object
        properties:
          baseline:
            type: boolean
            example: false
          comparison:
            type: boolean
            example: true
    resultmetadatatopfields:
      allOf:
      - $ref: '#/components/schemas/objecttopspec'
      - type: object
        properties:
          name:
            type: string
            example: a
          byte_size:
            type: number
            example: 1234
    resultsingle:
      allOf:
      - $ref: '#/components/schemas/objectspec'
      - type: object
        properties:
          cpuQuotient1:
            type: number
            example: 12.3
    comparison:
      type: object
      properties:
        objHeavy:
          $ref: '#/components/schemas/sortedcomparisonoobjheavy'
        rowCount:
          $ref: '#/components/schemas/cmpint'
        objNoCache:
          $ref: '#/components/schemas/sortedcomparisonobjresponsetime'
        sheetCount:
          $ref: '#/components/schemas/cmpint'
        fileSizeMib:
          $ref: '#/components/schemas/cmpfloat'
        objectCount:
          $ref: '#/components/schemas/cmpint'
        maxMemoryMib:
          $ref: '#/components/schemas/cmpfloat'
        sheetsCached:
          $ref: '#/components/schemas/sortedcomparisonobjresponsetime'
        objSlowCached:
          $ref: '#/components/schemas/sortedcomparisonobjresponsetime'
        objMemoryLimit:
          $ref: '#/components/schemas/comparisonobjMemoryLimit'
        sheetsUncached:
          $ref: '#/components/schemas/sortedcomparisonobjresponsetime'
        documentSizeMib:
          $ref: '#/components/schemas/cmpfloat'
        objSlowUncached:
          $ref: '#/components/schemas/sortedcomparisonobjresponsetime'
        dataModelSizeMib:
          $ref: '#/components/schemas/cmpfloat'
        hasSectionAccess:
          $ref: '#/components/schemas/cmpbool'
        topFieldsByBytes:
          $ref: '#/components/schemas/sortedcomparisonfields'
        topTablesByBytes:
          $ref: '#/components/schemas/sortedcomparisontables'
        objSingleThreaded:
          $ref: '#/components/schemas/sortedcomparisonobjresponsetime'
        appOpenTimeSeconds:
          $ref: '#/components/schemas/cmpfloat'
    sortedcomparisonoobjheavy:
      allOf:
      - type: object
        properties:
          list:
            $ref: '#/components/schemas/comparisonoobjheavy'
          absoluteDiffAsc:
            $ref: '#/components/schemas/comparisonoobjheavy'
          relativeDiffAsc:
            $ref: '#/components/schemas/comparisonoobjheavy'
          absoluteDiffDesc:
            $ref: '#/components/schemas/comparisonoobjheavy'
          dataSourceStatus:
            enum:
            - full
            - none
            - baselinemissing
            - comparisonmissing
            type: string
            example: full
          relativeDiffDesc:
            $ref: '#/components/schemas/comparisonoobjheavy'
    comparisonobjresponsetime:
      type: array
      items:
        allOf:
        - $ref: '#/components/schemas/objectspec'
        - type: object
          properties:
            dataSourceStatus:
              enum:
              - full
              - none
              - baselinemissing
              - comparisonmissing
              type: string
              example: full
            responseTimeSeconds1:
              $ref: '#/components/schemas/cmpfloatWithTimeout'
            responseTimeSeconds2:
              $ref: '#/components/schemas/cmpfloatWithTimeout'
    comparisonobjMemoryLimit:
      type: array
      items:
        allOf:
        - $ref: '#/components/schemas/objectspec'
        - type: object
          properties:
            dataSourceStatus:
              enum:
              - full
              - none
              - baselinemissing
              - comparisonmissing
              type: string
              example: full
            baselineMemoryLimitStatusCode:
              type: string
              example: OUT-OF-MEMORY
            comparisonMemoryLimitStatusCode:
              type: string
              example: OUT-OF-MEMORY
    objecttopspec:
      type: object
      properties:
        name:
          type: string
          format: string
          example: some field/table
        byte_size:
          type: number
          example: 12873
        is_system:
          type: boolean
          example: false
    sortedcomparisonfields:
      allOf:
      - type: object
        properties:
          list:
            $ref: '#/components/schemas/comparisonfields'
          absoluteDiffAsc:
            $ref: '#/components/schemas/comparisonfields'
          relativeDiffAsc:
            $ref: '#/components/schemas/comparisonfields'
          absoluteDiffDesc:
            $ref: '#/components/schemas/comparisonfields'
          dataSourceStatus:
            enum:
            - full
            - none
            - baselinemissing
            - comparisonmissing
            type: string
            example: full
          relativeDiffDesc:
            $ref: '#/components/schemas/comparisonfields'
    EvaluatorError:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                example: ERR-INVALID-AUTH
              title:
                type: string
                example: An error occured
              status:
                type: integer
                format: int32
                example: 427
    objectmetrics:
      type: object
      properties:
        cpuSeconds:
          type: array
          items:
            type: number
            example: 12.3
        cpuQuotients:
          type: array
          items:
            type: number
            example: 12.3
        responseTimeSeconds:
          type: number
          example: 234.3
    resultentry:
      allOf:
      - $ref: '#/components/schemas/objectspec'
      - type: object
        properties:
          passes:
            type: array
            items:
              $ref: '#/components/schemas/objectmetrics'
    cmpint:
      allOf:
      - $ref: '#/components/schemas/classification'
      - type: object
        properties:
          baseline:
            type: number
            example: 1
          comparison:
            type: number
            example: 2
    resultobjsheet:
      type: object
      properties:
        sheet:
          $ref: '#/components/schemas/resultobjresponsetime'
        objectCount:
          type: number
          example: 1
        sheetObjects:
          type: array
          items:
            $ref: '#/components/schemas/resultobjresponsetime'
    classification:
      allOf:
      - type: object
        properties:
          diff:
            type: number
            example: 0.5
          trend:
            type: string
            example: up
          absoluteDiff:
            type: number
            example: 2.5
    cmpfloatWithTimeout:
      allOf:
      - $ref: '#/components/schemas/cmpfloat'
      - type: object
        properties:
          baselineTimeoutStatusCode:
            type: string
            example: CALC-TIMEOUT
          comparisonTimeoutStatusCode:
            type: string
            example: CALC-TIMEOUT
    metadata:
      type: object
      properties:
        reloadmeta:
          type: object
          properties:
            cpuspent:
              type: number
              example: '123983'
            peakmemorybytes:
              type: number
              example: 112
        amountofrows:
          type: number
          example: 1423423234
        amountoffields:
          type: number
          example: 12
        amountoftables:
          type: number
          example: 7
        staticbytesize:
          type: number
          example: 1444234
        hassectionaccess:
          type: boolean
          example: false
        amountoffieldvalues:
          type: number
          example: 144423433
        amountofcardinalfieldvalues:
          type: number
          example: 14442
    sortedcomparisontables:
      allOf:
      - type: object
        properties:
          list:
            $ref: '#/components/schemas/comparisontables'
          absoluteDiffAsc:
            $ref: '#/components/schemas/comparisontables'
          relativeDiffAsc:
            $ref: '#/components/schemas/comparisontables'
          absoluteDiffDesc:
            $ref: '#/components/schemas/comparisontables'
          dataSourceStatus:
            enum:
            - full
            - none
            - baselinemissing
            - comparisonmissing
            type: string
            example: full
          relativeDiffDesc:
            $ref: '#/components/schemas/comparisontables'
    resultmetadatatoptables:
      allOf:
      - $ref: '#/components/schemas/objecttopspec'
      - type: object
        properties:
          name:
            type: string
            example: a
          byte_size:
            type: number
            example: 1234