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

# Obtener métricas del sistema

> Devuelve recuentos agregados de plantillas, informes, fuentes de datos y errores.



## OpenAPI

````yaml es/openapi/v3-current/reporter.yaml get /v1/metrics
openapi: 3.1.0
info:
  contact:
    name: Discord community
    url: https://discord.gg/DnhqKwkGv3
  description: >-
    Esta es la documentación OpenAPI de Reporter. El binario unificado de
    Reporter ejecuta la API REST (RUN_MODE=api), el worker de generación de
    informes de RabbitMQ (RUN_MODE=worker) o ambos; RUN_MODE=all ejecuta los dos
    en un único proceso para el desarrollo local. Todos los endpoints REST
    documentados aquí solo están disponibles cuando RUN_MODE=api o RUN_MODE=all
    (puerto :4005); el worker (puerto :4006) expone únicamente los endpoints de
    health y readyz.
  license:
    name: Lerian Studio General License
  title: Midaz Reporter API
  version: 4.0.0
servers:
  - url: http://localhost:4005
  - url: https://localhost:4005
security:
  - BearerAuth: []
tags:
  - description: Instancias de informes generados y su ciclo de vida.
    name: Informes
  - description: Definiciones de informes reutilizables.
    name: Plantillas
  - description: Creación interactiva de plantillas de informes.
    name: Constructor de plantillas
  - description: Seguimiento de las fechas de vencimiento de informes programados.
    name: Plazos
  - description: Entradas configuradas que proporcionan datos a los informes.
    name: Fuentes de datos
  - description: Métricas agregadas de informes.
    name: Métricas
  - description: Catálogo publicado de eventos de negocio y políticas de entrega.
    name: Streaming
paths:
  /v1/metrics:
    get:
      tags:
        - Métricas
      summary: Obtener métricas del sistema
      description: >-
        Devuelve recuentos agregados de plantillas, informes, fuentes de datos y
        errores.
      operationId: getMetrics
      parameters:
        - description: Número de días del período de errores.
          example: 7
          in: query
          name: errorPeriodDays
          schema:
            default: 7
            description: Número de días del período de errores.
            maximum: 365
            minimum: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsHumaResponse'
          description: Correcto
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Solicitud incorrecta
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: No autorizado
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Prohibido
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error interno del servidor
components:
  schemas:
    MetricsHumaResponse:
      properties:
        dataSources:
          description: Número total de fuentes de datos conectadas.
          examples:
            - 3
          format: int64
          type: integer
        errors:
          $ref: '#/components/schemas/ErrorMetricsHumaResponse'
          description: >-
            Contadores de errores de informes para las ventanas actual y
            anterior.
          examples:
            - previousPeriodTotal: 12
              total: 7
        reports:
          description: Número total de ejecuciones de informes.
          examples:
            - 156
          format: int64
          type: integer
        templates:
          description: Número total de plantillas de informes.
          examples:
            - 42
          format: int64
          type: integer
      type: object
    Detail:
      properties:
        code:
          description: >-
            Código de error de dominio estable y legible por máquina, limitado
            al servicio emisor (formato: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: Explicación legible específica de esta instancia del problema.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Lista opcional de detalles individuales del error
          examples:
            - - location: body.templateId
                message: expected string to match 'uuid' format
                value: not-a-uuid
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: Referencia URI que identifica la instancia específica del problema.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: Código de estado HTTP
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            Resumen breve y legible del tipo de problema. Este valor no debe
            cambiar entre instancias del error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: Referencia URI a la documentación legible del error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    ErrorMetricsHumaResponse:
      properties:
        previousPeriodTotal:
          description: >-
            Errores registrados durante el período inmediatamente anterior de
            igual duración.
          examples:
            - 12
          format: int64
          type: integer
        total:
          description: Errores registrados durante el período actual.
          examples:
            - 7
          format: int64
          type: integer
      type: object
    ErrorDetail:
      properties:
        location:
          description: >-
            Lugar donde ocurrió el error, por ejemplo, 'body.items[3].tags' o
            'path.thing-id'
          examples:
            - body.templateId
          type: string
        message:
          description: Texto del mensaje de error
          examples:
            - expected string to match 'uuid' format
          type: string
        value:
          description: Valor en la ubicación indicada
          examples:
            - not-a-uuid
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: >-
        Autenticación mediante token Bearer. Formato: 'Bearer {access_token}'.
        Solo es obligatoria cuando el plugin de autenticación está habilitado.
      scheme: bearer
      type: http

````