> ## Documentation Index
> Fetch the complete documentation index at: https://docs.appliedai.club/llms.txt
> Use this file to discover all available pages before exploring further.

# Check Batch Status

> Get the status and results of a batch analysis request

Check the processing status and retrieve results for a batch of analyzed tickets.

<RequestExample>
  ```bash cURL theme={null}
  curl https://api.example.com/api/cs-qa/v1/status/batch-123 \
    -H "Authorization: YOUR_API_KEY"
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      "https://api.example.com/api/cs-qa/v1/status/batch-123",
      headers={"Authorization": "YOUR_API_KEY"}
  )
  print(response.json())
  ```
</RequestExample>


## OpenAPI

````yaml GET /api/cs-qa/v1/status/{batch_id}
openapi: 3.1.0
info:
  title: Freshdesk Quality Assistant API
  description: API for analyzing customer service ticket quality
  version: 1.0.0
servers: []
security:
  - APIKeyHeader: []
paths:
  /api/cs-qa/v1/status/{batch_id}:
    get:
      tags:
        - cs-qa
        - CS QA
      summary: Get Batch Status
      description: |-
        Get the status of a batch processing request

        Returns:
        - Batch processing status
        - Count of processed and failed tickets
        - Results if processing is complete
        - Errors if any occurred
      operationId: get_batch_status_api_cs_qa_v1_status__batch_id__get
      parameters:
        - name: batch_id
          in: path
          required: true
          schema:
            type: string
            title: Batch Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchQAResponse'
        '401':
          description: Invalid or missing API key
          content:
            application/json:
              example:
                detail: Invalid API key
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              example:
                detail: Too many requests. Please try again later.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
              example:
                detail: Internal server error
      security:
        - APIKeyHeader: []
components:
  schemas:
    BatchQAResponse:
      properties:
        batch_id:
          type: string
          format: uuid
          title: Batch Id
        total_tickets:
          type: integer
          title: Total Tickets
        processed_tickets:
          type: integer
          title: Processed Tickets
        failed_tickets:
          type: integer
          title: Failed Tickets
        status:
          type: string
          title: Status
          default: pending
        results:
          anyOf:
            - items:
                $ref: '#/components/schemas/QAResult'
              type: array
            - type: 'null'
          title: Results
        errors:
          anyOf:
            - additionalProperties:
                type: string
              type: object
            - type: 'null'
          title: Errors
      type: object
      required:
        - batch_id
        - total_tickets
        - processed_tickets
        - failed_tickets
      title: BatchQAResponse
    ValidationError:
      properties:
        detail:
          items:
            type: object
          type: array
          title: Detail
      type: object
      required:
        - detail
      title: ValidationError
      description: Validation error response schema
    ErrorDetail:
      properties:
        detail:
          type: string
          title: Detail
      type: object
      required:
        - detail
      title: ErrorDetail
      description: Standard error response schema
    QAResult:
      properties:
        ticket_id:
          type: string
          title: Ticket Id
        agent_id:
          type: string
          title: Agent Id
        parameter_name:
          type: string
          title: Parameter Name
        value:
          anyOf:
            - type: string
            - type: integer
            - type: number
            - type: boolean
            - type: 'null'
          title: Value
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
      type: object
      required:
        - ticket_id
        - agent_id
        - parameter_name
        - reason
      title: QAResult
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization
      description: Enter your API key

````