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

# Catalog

> List every public metric, unit, scope, aggregation, grouping dimension, and retention tier.



## OpenAPI

````yaml /openapi.json get /v1/orgs/{orgId}/metrics/catalog
openapi: 3.1.0
info:
  title: Korve API
  version: 0.1.0
  description: >-
    Typed control plane for deploying applications and explicitly provisioning
    their managed infrastructure.
servers:
  - url: https://api.korve.dev
security: []
paths:
  /v1/orgs/{orgId}/metrics/catalog:
    get:
      tags:
        - metrics
      summary: Catalog
      description: >-
        List every public metric, unit, scope, aggregation, grouping dimension,
        and retention tier.
      operationId: metrics.catalog
      parameters:
        - name: orgId
          in: path
          required: true
          schema:
            type: string
          description: The organization's id (UUID) or slug — either form is accepted.
      responses:
        '200':
          description: Provider-neutral public metrics catalog.
          content:
            application/json:
              schema:
                type: object
                properties:
                  retention:
                    type: object
                    properties:
                      rawDays:
                        type: integer
                      hourlyMonths:
                        type: integer
                    required:
                      - rawDays
                      - hourlyMonths
                  metrics:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          enum:
                            - cpu.percent
                            - memory.used_bytes
                            - memory.limit_bytes
                            - disk.used_bytes
                            - disk.limit_bytes
                            - disk.read_iops
                            - disk.write_iops
                            - network.receive_bytes
                            - network.transmit_bytes
                            - runtime.restarts
                            - runtime.uptime_seconds
                            - http.requests
                            - http.errors
                            - database.connections
                            - database.pool_waiting
                            - database.queries_per_second
                            - database.query_latency_avg_ms
                            - database.query_latency_p50_ms
                            - database.query_latency_p90_ms
                            - database.query_latency_p95_ms
                            - database.query_latency_p99_ms
                            - queue.backlog_messages
                            - queue.oldest_message_age_seconds
                            - cron.failures
                        label:
                          type: string
                        description:
                          type: string
                        unit:
                          type: string
                        category:
                          type: string
                          enum:
                            - compute
                            - memory
                            - storage
                            - network
                            - http
                            - database
                            - queue
                            - cron
                        scopes:
                          type: array
                          items:
                            type: string
                            enum:
                              - project
                              - database
                          minItems: 1
                        defaultAggregation:
                          type: string
                          enum:
                            - avg
                            - min
                            - max
                            - sum
                            - p50
                            - p95
                            - p99
                        supportedAggregations:
                          type: array
                          items:
                            type: string
                            enum:
                              - avg
                              - min
                              - max
                              - sum
                              - p50
                              - p95
                              - p99
                          minItems: 1
                        groupBy:
                          type: array
                          items:
                            type: string
                            enum:
                              - instance
                              - process
                              - route
                              - status
                              - queue
                              - cron
                      required:
                        - name
                        - label
                        - description
                        - unit
                        - category
                        - scopes
                        - defaultAggregation
                        - supportedAggregations
                        - groupBy
                    minItems: 24
                    maxItems: 24
                required:
                  - retention
                  - metrics
      security:
        - apiKey: []
        - session: []
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: korve_api_key
    session:
      type: apiKey
      in: cookie
      name: korve.session_token

````