> ## 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.

# List burn-in evaluation candidates (internal)

> List bounded burn-in evaluation materialisation candidates for one scope.



## OpenAPI

````yaml /openapi/fleet-manager-openapi.yaml get /api/v1/burn-in/evaluations/candidates/
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/evaluations/candidates/:
    get:
      tags:
        - Burn-in
      summary: List burn-in evaluation candidates (internal)
      description: >-
        List bounded burn-in evaluation materialisation candidates for one
        scope.
      operationId: api_v1_burn_in_evaluations_candidates_retrieve
      parameters:
        - in: query
          name: limit
          schema:
            type: integer
            maximum: 500
            minimum: 1
          description: >-
            Candidate batch size. Defaults to 100; a value above 500 is rejected
            rather than clamped.
        - in: query
          name: resource_class
          schema:
            type: string
          description: Device resource class for the candidate scope.
          required: true
        - in: query
          name: site_id
          schema:
            type: string
            format: uuid
          description: Site identifier for the candidate scope.
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BurnInEvaluationCandidateBatch'
          description: ''
        '400':
          description: Validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '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'
      security:
        - oauth2:
            - test-execution:evaluate
        - cookieAuth: []
components:
  schemas:
    BurnInEvaluationCandidateBatch:
      type: object
      description: Bounded candidate batch consumed by the evaluation agent.
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/BurnInEvaluationCandidate'
      required:
        - results
    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'
    BurnInEvaluationCandidate:
      type: object
      description: |-
        Candidate row for agent-side evaluation materialisation.

        Carries no source key: the agent stamps its result with the key of the
        thresholds it evaluated with, and the results upsert validates that key
        against the API's current resolution.
      properties:
        execution_id:
          type: string
          format: uuid
        test_slug:
          type: string
        status:
          $ref: '#/components/schemas/TestExecutionStatusEnum'
        metrics:
          allOf:
            - $ref: '#/components/schemas/MetricMap'
          nullable: true
        resolved_params:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
          nullable: true
        iteration_summary:
          allOf:
            - $ref: '#/components/schemas/IterationSummary'
          nullable: true
        nic_metrics:
          type: array
          items:
            type: object
            additionalProperties: true
          nullable: true
        resource_class:
          type: string
        updated_at:
          type: string
          format: date-time
        completed_at:
          type: string
          format: date-time
          nullable: true
      required:
        - completed_at
        - execution_id
        - iteration_summary
        - metrics
        - nic_metrics
        - resolved_params
        - resource_class
        - status
        - test_slug
        - updated_at
    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
    TestExecutionStatusEnum:
      enum:
        - completed
        - passed
        - failed
        - error
      type: string
      description: |-
        * `completed` - Completed
        * `passed` - Passed
        * `failed` - Failed
        * `error` - Error
    MetricMap:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/MetricValue'
      nullable: true
    JsonValue:
      description: Any JSON value.
      nullable: true
      anyOf:
        - type: string
        - type: number
        - type: integer
        - type: boolean
        - type: array
          items:
            $ref: '#/components/schemas/JsonValue'
        - type: object
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
    IterationSummary:
      type: object
      description: OpenAPI schema for iteration execution summary.
      properties:
        requested:
          type: integer
        completed:
          type: integer
        failed:
          type: integer
        completed_iterations:
          type: array
          items:
            type: integer
      required:
        - completed
        - completed_iterations
        - failed
        - requested
    MetricValue:
      type: object
      required:
        - value
      properties:
        value:
          $ref: '#/components/schemas/MetricDisplayValue'
        unit:
          type: string
          nullable: true
        statistics:
          allOf:
            - $ref: '#/components/schemas/StoredMetricStatistics'
          nullable: true
        detail:
          type: string
          nullable: true
    MetricDisplayValue:
      anyOf:
        - type: number
        - type: string
      nullable: true
    StoredMetricStatistics:
      type: object
      required:
        - mean
        - min
        - max
        - median
        - stdev
      properties:
        mean:
          type: number
        min:
          type: number
        max:
          type: number
        median:
          type: number
        stdev:
          type: number
  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.