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

# List Version Metrics

> List the metrics a published workspace version froze



## OpenAPI

````yaml get /v2/api/projects/{projectId}/workspaces/{workspaceId}/versions/{version}/metrics
openapi: 3.1.0
info:
  title: Upsolve API
  version: 1.5.0
servers:
  - url: https://api.upsolve.ai
security: []
tags: []
paths:
  /v2/api/projects/{projectId}/workspaces/{workspaceId}/versions/{version}/metrics:
    get:
      summary: List the metrics a published workspace version fr…
      description: List the metrics a published workspace version froze
      operationId: GetV2ApiProjectsProjectIdWorkspacesWorkspaceIdVersionsVersionMetrics
      parameters:
        - name: apiKey
          in: query
          required: false
          description: >-
            Upsolve API key, generated under Account → Developer settings in the
            Upsolve Hub. Keys are user-scoped: pass organizationId alongside the
            key to select which org to act on.
          schema:
            type: string
            minLength: 1
            description: >-
              Upsolve API key, generated under Account → Developer settings in
              the Upsolve Hub. Keys are user-scoped: pass organizationId
              alongside the key to select which org to act on.
            examples:
              - up_embed_************
          examples:
            example1:
              value: up_embed_************
        - name: organizationId
          in: query
          required: false
          description: >-
            Your Upsolve organization's UUID — the org that owns the API key and
            project. This is NOT a project organization: do not pass a value
            registered via /projects/register-organization, and do not pass an
            `externalId` (only `projectOrganizationId` accepts those). Omit it
            when using an org-bound API key — the org is read from the key and
            any value sent here is ignored. Required only for user-scoped API
            keys (created under Account → Developer settings) and for the
            Supabase JWT path, where the org is ambiguous and membership is
            verified against it.
          schema:
            description: >-
              Your Upsolve organization's UUID — the org that owns the API key
              and project. This is NOT a project organization: do not pass a
              value registered via /projects/register-organization, and do not
              pass an `externalId` (only `projectOrganizationId` accepts those).
              Omit it when using an org-bound API key — the org is read from the
              key and any value sent here is ignored. Required only for
              user-scoped API keys (created under Account → Developer settings)
              and for the Supabase JWT path, where the org is ambiguous and
              membership is verified against it.
            examples:
              - 123e4567-e89b-12d3-a456-426614174000
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
          examples:
            example1:
              value: 123e4567-e89b-12d3-a456-426614174000
        - name: projectId
          in: path
          required: true
          description: The project the workspace belongs to.
          schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
            description: The project the workspace belongs to.
        - name: workspaceId
          in: path
          required: true
          description: The workspace (data model) id.
          schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
            description: The workspace (data model) id.
        - name: version
          in: path
          required: true
          description: The published version number to read.
          schema:
            type: integer
            minimum: 1
            maximum: 9007199254740991
            description: The published version number to read.
        - name: q
          in: query
          required: false
          description: Filters by name, description or slug, case-insensitively.
          schema:
            description: Filters by name, description or slug, case-insensitively.
            type: string
            maxLength: 200
        - name: type
          in: query
          required: false
          description: Only metrics of this type.
          schema:
            description: Only metrics of this type.
            type: string
            enum:
              - simple
              - ratio
              - derived
        - name: tableKey
          in: query
          required: false
          description: Only simple metrics reading this table (schema.table).
          schema:
            description: Only simple metrics reading this table (schema.table).
            type: string
            maxLength: 500
      responses:
        '200':
          description: >-
            GET
            /v2/api/projects/:projectId/workspaces/:workspaceId/versions/:version/metrics
            Positive response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    const: success
                  data:
                    type: object
                    properties:
                      metrics:
                        type: array
                        items:
                          type: object
                          properties:
                            definition:
                              oneOf:
                                - type: object
                                  properties:
                                    slug:
                                      type: string
                                    name:
                                      type: string
                                    description:
                                      type: string
                                    format:
                                      type: string
                                      enum:
                                        - number
                                        - currency
                                        - percent
                                    type:
                                      type: string
                                      const: simple
                                    tableKey:
                                      type: string
                                    columnName:
                                      type: string
                                    aggregation:
                                      type: string
                                      enum:
                                        - sum
                                        - count
                                        - count_distinct
                                        - avg
                                        - min
                                        - max
                                    defaultFilters:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          column:
                                            type: string
                                          operator:
                                            type: string
                                            enum:
                                              - eq
                                              - neq
                                              - gt
                                              - lt
                                              - in
                                              - not_in
                                          value:
                                            anyOf:
                                              - type: string
                                              - type: number
                                              - type: array
                                                items:
                                                  anyOf:
                                                    - type: string
                                                    - type: number
                                        required:
                                          - column
                                          - operator
                                          - value
                                        additionalProperties: false
                                  required:
                                    - slug
                                    - name
                                    - description
                                    - format
                                    - type
                                    - tableKey
                                    - columnName
                                    - aggregation
                                    - defaultFilters
                                  additionalProperties: false
                                - type: object
                                  properties:
                                    slug:
                                      type: string
                                    name:
                                      type: string
                                    description:
                                      type: string
                                    format:
                                      type: string
                                      enum:
                                        - number
                                        - currency
                                        - percent
                                    type:
                                      type: string
                                      const: ratio
                                    numeratorMetricSlug:
                                      type: string
                                    denominatorMetricSlug:
                                      type: string
                                  required:
                                    - slug
                                    - name
                                    - description
                                    - format
                                    - type
                                    - numeratorMetricSlug
                                    - denominatorMetricSlug
                                  additionalProperties: false
                                - type: object
                                  properties:
                                    slug:
                                      type: string
                                    name:
                                      type: string
                                    description:
                                      type: string
                                    format:
                                      type: string
                                      enum:
                                        - number
                                        - currency
                                        - percent
                                    type:
                                      type: string
                                      const: derived
                                    formula:
                                      type: string
                                    referencedMetricSlugs:
                                      type: array
                                      items:
                                        type: string
                                  required:
                                    - slug
                                    - name
                                    - description
                                    - format
                                    - type
                                    - formula
                                    - referencedMetricSlugs
                                  additionalProperties: false
                              description: The metric exactly as this version published it.
                              discriminator:
                                propertyName: type
                            metricVersion:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                              description: >-
                                The metric's own version number, which a publish
                                increments.
                            publishedAt:
                              type:
                                - string
                                - 'null'
                            publishedBy:
                              type:
                                - string
                                - 'null'
                          required:
                            - definition
                            - metricVersion
                            - publishedAt
                            - publishedBy
                          additionalProperties: false
                    required:
                      - metrics
                    additionalProperties: false
                required:
                  - status
                  - data
                additionalProperties: false
        '400':
          description: >-
            GET
            /v2/api/projects/:projectId/workspaces/:workspaceId/versions/:version/metrics
            Negative response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    const: error
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      code:
                        type: string
                      details:
                        type: object
                        propertyNames:
                          type: string
                        additionalProperties: {}
                    required:
                      - message
                    additionalProperties: false
                required:
                  - status
                  - error
                additionalProperties: false
      security:
        - APIKEY_2: []
components:
  securitySchemes:
    APIKEY_2:
      type: apiKey
      in: query
      name: apiKey

````

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