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

# List quality evaluation metrics

> Returns the catalog of quality evaluation metrics available for monitoring — for example answer relevance, faithfulness, and custom criteria.

Use each entry's `name` as the `type` when building the `metrics` array in `PUT /applications/{applicationId}/monitoring`. Use `additionalFields` to know which extra keys (for example `threshold`) each metric accepts.



## OpenAPI

````yaml /openapi.json get /metrics/eval
openapi: 3.0.0
info:
  title: Trusys API
  version: 1.0.0
  description: >-
    Programmatic access to Trusys for integrating AI quality monitoring,
    evaluation, and guardrails into your own systems — without using the Trusys
    UI.


    **Typical integration flow**


    1. `POST /applications` — register your application and get an id.

    2. `PUT /applications/{id}/monitoring` and/or `PUT
    /applications/{id}/guardrails` — configure which metrics, security plugins,
    and guardrails apply.

    3. `POST /applications/{id}/evaluations` — submit prompt/response traces to
    be scored as your application runs.

    4. `GET /applications/{id}/traces`, `GET /applications/{id}/evaluations`,
    and `POST /applications/{id}/widget-data` — pull results, trends, and
    dashboard-equivalent chart data back into your own tools.


    All requests require an `x-api-key` header (see Authentication). All
    timestamps are ISO 8601 UTC. Paginated endpoints default to 20 items per
    page (max 100).
servers:
  - url: https://app.trusys.ai/api/external
security:
  - ApiKeyAuth: []
paths:
  /metrics/eval:
    get:
      tags:
        - Metrics
      summary: List quality evaluation metrics
      description: >-
        Returns the catalog of quality evaluation metrics available for
        monitoring — for example answer relevance, faithfulness, and custom
        criteria.


        Use each entry's `name` as the `type` when building the `metrics` array
        in `PUT /applications/{applicationId}/monitoring`. Use
        `additionalFields` to know which extra keys (for example `threshold`)
        each metric accepts.
      operationId: listEvalMetrics
      responses:
        '200':
          description: Eval metrics catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvalMetricsCatalogResponse'
              example:
                success: true
                data:
                  - id: answer-relevance
                    name: answer-relevance
                    label: Answer Relevance
                    description: Measures how relevant the response is to the user prompt
                    valueType: number
                    mandatory: 0
                    additionalFields:
                      - name: threshold
                        type: number
                        label: Threshold score
                        mandatory: true
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    EvalMetricsCatalogResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: array
          description: Available quality evaluation metrics.
          items:
            $ref: '#/components/schemas/EvalMetricsCatalogItem'
    EvalMetricsCatalogItem:
      type: object
      description: >-
        Quality evaluation metric definition for configuring monitoring. Use
        `name` as the `type` when building the `metrics` array in PUT
        monitoring.
      properties:
        id:
          type: string
          description: Stable metric identifier.
        name:
          type: string
          description: Metric type key — use as `type` in monitoring `metrics` entries.
        label:
          type: string
          nullable: true
          description: Human-readable metric name.
        description:
          type: string
          nullable: true
          description: What this metric measures.
        helpText:
          type: string
          nullable: true
          description: Guidance for configuring this metric.
        valueType:
          type: string
          nullable: true
          description: >-
            Expected shape of the metric value (for example `number`, `string`,
            `multiselect`).
        mandatory:
          type: integer
          description: >-
            Whether a primary value is required when configuring this metric
            (`1` = required, `0` = optional).
        additionalFields:
          type: array
          nullable: true
          description: Extra configuration fields (for example `threshold`).
          items:
            type: object
        options:
          type: array
          nullable: true
          description: Allowed values for multiselect-style metrics.
          items:
            type: object
    ErrorResponse:
      type: object
      description: Standard error envelope for non-validation failures.
      properties:
        success:
          type: boolean
          example: false
          description: Always `false` for errors.
        message:
          type: string
          description: Human-readable explanation of the error.
      required:
        - success
        - message
  responses:
    Unauthorized:
      description: >-
        The API key is missing, invalid, or revoked. Verify the `x-api-key`
        header and that the key is active in Trusys settings.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            message: Error while verifying api key
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Your Trusys API key. Create and manage keys in the Trusys UI under
        **Settings → API Keys**.


        Include the key on every request:


        ```

        x-api-key: <your-api-key>

        ```

````