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

# Get report run

> Report-run endpoints backed by report-generation jobs.



## OpenAPI

````yaml /openapi/fleet-manager-openapi.yaml get /api/v1/burn-in/report-runs/{id}/
openapi: 3.0.3
info:
  title: Fleet Manager API
  version: 1.0.0
  description: API for the Nscale Fleet Manager
servers: []
security: []
paths:
  /api/v1/burn-in/report-runs/{id}/:
    get:
      tags:
        - Burn-in
      summary: Get report run
      description: Report-run endpoints backed by report-generation jobs.
      operationId: api_v1_burn_in_report_runs_retrieve
      parameters:
        - in: path
          name: id
          schema:
            type: string
            format: uuid
          description: A UUID string identifying this job.
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportRun'
          description: ''
        '401':
          description: Authentication credentials were not provided or are invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: You do not have permission to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - oauth2:
            - job:read
        - cookieAuth: []
components:
  schemas:
    ReportRun:
      type: object
      description: Read serializer for report-run detail.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
          maxLength: 50
          pattern: ^[-a-zA-Z0-9_]+$
        site_slug:
          type: string
          nullable: true
          readOnly: true
        created_by:
          type: string
          nullable: true
          readOnly: true
        status:
          $ref: '#/components/schemas/JobStatusEnum'
        created_at:
          type: string
          format: date-time
          readOnly: true
        started_at:
          type: string
          format: date-time
          nullable: true
        completed_at:
          type: string
          format: date-time
          nullable: true
        test_selection_scope:
          allOf:
            - $ref: '#/components/schemas/TestSelectionScopeEnum'
          readOnly: true
        filters:
          allOf:
            - $ref: '#/components/schemas/ReportRunFilters'
          readOnly: true
        sections:
          type: array
          items:
            $ref: '#/components/schemas/ReportSectionEnum'
          readOnly: true
          description: Report sections included in this report run.
        cohort_hostlist:
          type: string
          readOnly: true
          description: >-
            Compressed hostlist derived from the devices associated with this
            report run.
        cohort_size:
          type: integer
          readOnly: true
          description: Number of devices associated with this report run after validation.
        download_status:
          allOf:
            - $ref: '#/components/schemas/ArtifactStatusEnum'
          readOnly: true
          description: Availability status for the canonical report-run download target.
        generate_logs:
          type: boolean
          readOnly: true
        report_status:
          allOf:
            - $ref: '#/components/schemas/ArtifactStatusEnum'
          readOnly: true
          description: Availability status for the main report artifact.
        logs_status:
          allOf:
            - $ref: '#/components/schemas/ArtifactStatusEnum'
          readOnly: true
          description: Availability status for logs index artifact generation.
      required:
        - cohort_hostlist
        - cohort_size
        - created_at
        - created_by
        - download_status
        - filters
        - generate_logs
        - id
        - logs_status
        - report_status
        - sections
        - site_slug
        - test_selection_scope
    ErrorResponse:
      type: object
      description: >-
        Uniform error body for every 4xx/5xx response. `detail` is a
        human-readable message, always present, safe to display to end users.
        `code` is the machine-readable identifier. `field_errors` lists
        per-input-field validation messages and is empty for non-field errors
        (auth, permission, not-found, conflict, server).
      required:
        - detail
        - code
        - field_errors
      properties:
        detail:
          type: string
        code:
          $ref: '#/components/schemas/ErrorCodeEnum'
        field_errors:
          type: array
          items:
            $ref: '#/components/schemas/FieldError'
    JobStatusEnum:
      enum:
        - pending
        - running
        - cancellation_requested
        - completed
        - failed
        - partially_failed
        - cancelled
        - terminated
        - superseded
        - timed_out
      type: string
      description: |-
        * `pending` - Pending
        * `running` - Running
        * `cancellation_requested` - Cancellation Requested
        * `completed` - Completed
        * `failed` - Failed
        * `partially_failed` - Partially Failed
        * `cancelled` - Cancelled
        * `terminated` - Terminated
        * `superseded` - Superseded
        * `timed_out` - Timed Out
    TestSelectionScopeEnum:
      type: string
      enum:
        - all
        - custom
    ReportRunFilters:
      type: object
      description: Request/response serializer for report-run filters.
      properties:
        start_date:
          type: string
          format: date-time
          nullable: true
        end_date:
          type: string
          format: date-time
          nullable: true
        test_slugs:
          type: array
          items:
            type: string
        result_filter:
          allOf:
            - $ref: '#/components/schemas/ResultFilterEnum'
          default: all
    ReportSectionEnum:
      type: string
      enum:
        - inventory
        - enrollment
        - health
        - burn_in
    ArtifactStatusEnum:
      type: string
      enum:
        - pending
        - available
        - unavailable
    ErrorCodeEnum:
      type: string
      description: >-
        Stable machine-readable error identifier. New members may be added
        within this API version; clients must tolerate unknown values.
      enum:
        - error
        - invalid
        - parse_error
        - authentication_failed
        - not_authenticated
        - permission_denied
        - not_found
        - method_not_allowed
        - not_acceptable
        - unsupported_media_type
        - conflict
        - enrollment_infrastructure_reference_pending
        - enrollment_infrastructure_reference_changed
        - unprocessable_entity
        - throttled
        - service_unavailable
    FieldError:
      type: object
      description: One input field's validation messages.
      required:
        - field
        - messages
      properties:
        field:
          type: string
          description: >-
            Dotted path to the offending input field, or to the collection row
            when the whole row is invalid (e.g. `filters.end_date`,
            `memberships.0.role`, `memberships.0`).
        messages:
          type: array
          minItems: 1
          items:
            type: string
    ResultFilterEnum:
      enum:
        - all
        - passing
        - failing
        - error
      type: string
      description: |-
        * `all` - all
        * `passing` - passing
        * `failing` - failing
        * `error` - error
  securitySchemes:
    oauth2:
      type: oauth2
      flows: {}
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.