openapi: 3.0.3
info:
  title: Apache JMeter REST Results API
  description: REST API for Apache JMeter test control and monitoring. Provides endpoints for starting, stopping, and monitoring load tests remotely, and for accessing test results.
  version: 5.6.3
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  contact:
    email: dev@jmeter.apache.org
servers:
- url: http://localhost:4445
  description: JMeter REST API server
tags:
- name: Results
  description: Test results access
paths:
  /results:
    get:
      operationId: getResults
      summary: Apache JMeter Get Results
      description: Retrieve test results from the running or completed test.
      tags:
      - Results
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      parameters:
      - name: since
        in: query
        schema:
          type: integer
        description: Return results since this timestamp
        example: 1718153645993
      responses:
        '200':
          description: Test results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResults'
              examples:
                getResults200Example:
                  summary: Default getResults 200 response
                  x-microcks-default: true
                  value:
                    testId: test-1234
                    totalRequests: 10000
                    errorCount: 50
                    averageResponseTime: 250.5
                    minResponseTime: 50.0
                    maxResponseTime: 5000.0
                    percentile90: 500.0
                    throughput: 148.7
components:
  schemas:
    TestResults:
      type: object
      description: Test performance results
      properties:
        testId:
          type: string
          example: test-1234
        totalRequests:
          type: integer
          example: 10000
        errorCount:
          type: integer
          example: 50
        averageResponseTime:
          type: number
          description: Average response time in milliseconds
          example: 250.5
        minResponseTime:
          type: number
          example: 50.0
        maxResponseTime:
          type: number
          example: 5000.0
        percentile90:
          type: number
          description: 90th percentile response time
          example: 500.0
        throughput:
          type: number
          description: Average throughput in requests/second
          example: 148.7