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

# List metrics

> List metrics, each once, with the id of its active revision and no revision inline. The list holds the metrics of the caller's organization and the Galtea metrics. A caller limited to the products its user groups grant also sees only the metrics those products use, and the Galtea metrics. See [Metrics](https://docs.galtea.ai/concepts/metric).



## OpenAPI

````yaml /openapi.json get /v2/metrics
openapi: 3.0.0
info:
  version: 1.0.0
  title: Product Management Service API
  description: API documentation for Product Management Service
  contact:
    name: Galtea AI
servers:
  - url: https://api.galtea.ai
security:
  - bearerAuth: []
tags: []
externalDocs:
  description: Galtea Platform Documentation
  url: https://docs.galtea.ai
paths:
  /v2/metrics:
    get:
      tags:
        - metrics-v2
      summary: List metrics
      description: >-
        List metrics, each once, with the id of its active revision and no
        revision inline. The list holds the metrics of the caller's organization
        and the Galtea metrics. A caller limited to the products its user groups
        grant also sees only the metrics those products use, and the Galtea
        metrics. See [Metrics](https://docs.galtea.ai/concepts/metric).
      operationId: listMetricsV2
      parameters:
        - schema:
            type: array
            items:
              type: string
            description: Filter by metric IDs
          required: false
          description: Filter by metric IDs
          style: form
          explode: true
          name: ids
          in: query
        - schema:
            type: string
            description: Filter by metric name (partial match, case insensitive)
          required: false
          description: Filter by metric name (partial match, case insensitive)
          name: name
          in: query
        - schema:
            type: array
            items:
              type: string
            description: Filter by metric names (exact match, case insensitive, multiple)
          required: false
          description: Filter by metric names (exact match, case insensitive, multiple)
          style: form
          explode: true
          name: names
          in: query
        - schema:
            type: array
            items:
              type: string
            description: Filter by tags; a metric matches when it holds one of them
          required: false
          description: Filter by tags; a metric matches when it holds one of them
          style: form
          explode: true
          name: tags
          in: query
        - schema:
            type: array
            items:
              type: string
              enum:
                - SELF_HOSTED
                - FULL_PROMPT
                - PARTIAL_PROMPT
                - HUMAN_EVALUATION
                - GEVAL
                - DEEPEVAL
                - DETERMINISTIC
                - CLASSIFIER
            description: Filter by metric sources
          required: false
          description: Filter by metric sources
          style: form
          explode: true
          name: sources
          in: query
        - schema:
            type: boolean
            description: >-
              Also list the metrics whose active revision is excluded from
              analytics. Defaults to false. A metric named in `ids` is listed
              either way.
          required: false
          description: >-
            Also list the metrics whose active revision is excluded from
            analytics. Defaults to false. A metric named in `ids` is listed
            either way.
          name: includeExcludedFromAnalytics
          in: query
        - schema:
            type: array
            items:
              type: string
            description: >-
              Sort instructions (field and direction pairs). The fields are
              `name` and `createdAt`.
          required: false
          description: >-
            Sort instructions (field and direction pairs). The fields are `name`
            and `createdAt`.
          style: form
          explode: true
          name: sort
          in: query
        - schema:
            type: integer
            minimum: 0
            maximum: 9007199254740991
            default: 10000
            description: Maximum number of results
          required: false
          description: Maximum number of results
          name: limit
          in: query
        - schema:
            type: integer
            minimum: 0
            default: 0
            description: Number of results to skip
          required: false
          description: Number of results to skip
          name: offset
          in: query
      responses:
        '200':
          description: Metrics retrieved successfully
          headers:
            Content-Range:
              schema:
                type: string
                description: Pagination range as `metrics <offset>-<upperBound>/<total>`.
              required: true
              description: Pagination range as `metrics <offset>-<upperBound>/<total>`.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MetricV2'
        '400':
          description: >-
            Invalid query parameter, including an unknown source, sort field or
            sort direction
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: No user group of the caller lists metric.read
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: A metric in `ids` is not found or out of the caller scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    MetricV2:
      type: object
      properties:
        id:
          type: string
          example: metric_123
          description: Metric ID.
        organizationId:
          type: string
          nullable: true
          example: org_123
          description: The organization of the metric. Null for a Galtea metric.
        userId:
          type: string
          nullable: true
          example: user_123
        name:
          type: string
          example: Accuracy
          description: Metric name, unique in its organization.
        description:
          type: string
          nullable: true
          example: Measures the accuracy of responses
        tags:
          type: array
          items:
            type: string
          example:
            - accuracy
            - quality
        documentationUrl:
          type: string
          nullable: true
          example: https://docs.example.com/metrics/accuracy
        source:
          type: string
          nullable: true
          enum:
            - SELF_HOSTED
            - FULL_PROMPT
            - PARTIAL_PROMPT
            - HUMAN_EVALUATION
            - GEVAL
            - DEEPEVAL
            - DETERMINISTIC
            - CLASSIFIER
          example: PARTIAL_PROMPT
          description: >-
            Evaluation method for the metric. `FULL_PROMPT` is deprecated for
            creation — `POST /metrics` rejects it with a 400. Use
            `PARTIAL_PROMPT` for new AI Evaluation metrics. The value remains in
            the enum because existing FULL_PROMPT metrics are still returned by
            reads and filters. `CLASSIFIER` is the Classifier judge, accepted
            only where the deployment enables it.
        activeRevisionId:
          type: string
          nullable: true
          readOnly: true
          example: revision_123
          description: >-
            The revision that evaluations of this metric run. Null when no
            revision is active.
        createdAt:
          type: string
          format: date-time
        disabledAt:
          type: string
          nullable: true
          format: date-time
          readOnly: true
          description: >-
            The metric's own disabled date. It ignores the evaluator model of
            each revision: read a revision for that.
      required:
        - id
        - organizationId
        - userId
        - name
        - description
        - tags
        - documentationUrl
        - source
        - activeRevisionId
        - createdAt
        - disabledAt
    Error:
      type: object
      properties:
        error:
          type: string
          example: Error type
        message:
          type: string
          example: Error message description
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key authorization. Pass your API key in the Authorization header as
        a Bearer token. Both new (`gsk_*`) and legacy (`gsk-`) API keys are
        accepted, e.g. `Authorization: Bearer gsk_...` or `Authorization: Bearer
        gsk-...`.

````

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