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

# Obtener una métrica operativa

> Lee una métrica operativa determinística de la lista permitida como contrato de evidencia (value, unit, asOf, filters), calculada en vivo sobre los datos de la clínica dental. Requiere analytics:read. Un nombre de métrica desconocido devuelve 400. Las métricas de valor se omiten salvo que la clave tenga el scope de valor (ninguna en v1).



## OpenAPI

````yaml /openapi.es.json get /v1/analytics/metrics/{metric}
openapi: 3.1.0
info:
  description: >-
    La API pública para desarrolladores de Muveya: recursos /v1 de solo lectura,
    limitados a un tenant y autenticados con una clave de API opaca. Un
    presupuesto de solicitudes por clave.
  title: API para desarrolladores de Muveya
  version: 0.1.0
servers:
  - description: Producción
    url: https://api.muveya.com
security: []
tags:
  - name: Clave de API
  - name: Clínicas
  - name: Bodegas
  - name: Catálogo
  - name: Inventario
  - name: Pedidos
  - name: Entregas
  - name: Analítica
paths:
  /v1/analytics/metrics/{metric}:
    get:
      tags:
        - Analítica
      summary: Obtener una métrica operativa
      description: >-
        Lee una métrica operativa determinística de la lista permitida como
        contrato de evidencia (value, unit, asOf, filters), calculada en vivo
        sobre los datos de la clínica dental. Requiere analytics:read. Un nombre
        de métrica desconocido devuelve 400. Las métricas de valor se omiten
        salvo que la clave tenga el scope de valor (ninguna en v1).
      operationId: getAnalyticsMetric
      parameters:
        - name: metric
          in: path
          required: true
          description: La clave de la métrica, de la lista permitida.
          schema:
            type: string
            enum:
              - LOW_STOCK
              - EXPIRING_STOCK
              - DELIVERY_EXCEPTIONS
              - RECEIPT_DISCREPANCIES
              - PENDING_ORDERS
              - BOX_TRACEABILITY
              - APPROVAL_DECISION_MEDIAN_HOURS
              - DISTINCT_CUSTODY_ACTORS
        - name: catalogItemId
          in: query
          required: false
          description: >-
            Limita las métricas de existencias (LOW_STOCK, EXPIRING_STOCK) a un
            insumo del catálogo.
          schema:
            type: string
        - name: from
          in: query
          required: false
          description: >-
            Inicio inclusivo de la ventana, en ISO-8601, para
            APPROVAL_DECISION_MEDIAN_HOURS (por envío) y DISTINCT_CUSTODY_ACTORS
            (por recepción).
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          description: Fin exclusivo de esa ventana, en ISO-8601.
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: La métrica solicitada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SemanticMetric'
          headers:
            X-RateLimit-Limit:
              description: El presupuesto de solicitudes por clave en la ventana actual.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Remaining:
              description: Solicitudes restantes en la ventana actual (0 cuando se agotan).
              schema:
                type: integer
                minimum: 0
            X-RateLimit-Reset:
              description: Segundos hasta que se reinicie la ventana actual.
              schema:
                type: integer
                minimum: 1
            RateLimit:
              description: >-
                Estado del presupuesto de solicitudes según el borrador de la
                IETF, por ejemplo "limit=120, remaining=119, reset=60".
              schema:
                type: string
            RateLimit-Policy:
              description: >-
                Política según el borrador de la IETF, por ejemplo "120;w=60"
                (límite;segundos de la ventana).
              schema:
                type: string
        '400':
          description: El nombre no corresponde a una métrica conocida.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          headers:
            X-RateLimit-Limit:
              description: El presupuesto de solicitudes por clave en la ventana actual.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Remaining:
              description: Solicitudes restantes en la ventana actual (0 cuando se agotan).
              schema:
                type: integer
                minimum: 0
            X-RateLimit-Reset:
              description: Segundos hasta que se reinicie la ventana actual.
              schema:
                type: integer
                minimum: 1
            RateLimit:
              description: >-
                Estado del presupuesto de solicitudes según el borrador de la
                IETF, por ejemplo "limit=120, remaining=119, reset=60".
              schema:
                type: string
            RateLimit-Policy:
              description: >-
                Política según el borrador de la IETF, por ejemplo "120;w=60"
                (límite;segundos de la ventana).
              schema:
                type: string
        '401':
          description: >-
            La clave de API falta, no es válida, fue revocada, expiró o está
            vinculada a una clínica dental suspendida.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: La clave de API no tiene el scope que requiere esta ruta.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: >-
            La clave de API superó su límite de solicitudes en la ventana
            actual.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          headers:
            Retry-After:
              description: Segundos (valor positivo) hasta que se permita otra solicitud.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Limit:
              description: El presupuesto de solicitudes por clave en la ventana actual.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Remaining:
              description: Solicitudes restantes en la ventana actual (0 cuando se agotan).
              schema:
                type: integer
                minimum: 0
            X-RateLimit-Reset:
              description: Segundos hasta que se reinicie la ventana actual.
              schema:
                type: integer
                minimum: 1
            RateLimit:
              description: >-
                Estado del presupuesto de solicitudes según el borrador de la
                IETF, por ejemplo "limit=120, remaining=119, reset=60".
              schema:
                type: string
            RateLimit-Policy:
              description: >-
                Política según el borrador de la IETF, por ejemplo "120;w=60"
                (límite;segundos de la ventana).
              schema:
                type: string
      security:
        - apiKeyBearer: []
components:
  schemas:
    SemanticMetric:
      type: object
      additionalProperties: false
      required:
        - metric
        - value
        - unit
        - timezone
        - asOf
        - freshness
        - evidenceId
        - truncated
        - filters
      properties:
        metric:
          type: string
          enum:
            - LOW_STOCK
            - EXPIRING_STOCK
            - DELIVERY_EXCEPTIONS
            - RECEIPT_DISCREPANCIES
            - PENDING_ORDERS
            - BOX_TRACEABILITY
            - APPROVAL_DECISION_MEDIAN_HOURS
            - DISTINCT_CUSTODY_ACTORS
        value:
          type:
            - number
            - 'null'
          description: >-
            La cifra; null cuando un porcentaje o una mediana no tiene muestra,
            nunca cero.
        unit:
          type: string
          description: 'La unidad del valor: count, percent o hours.'
        definition:
          type: string
          description: Lo que mide la cifra, en palabras.
        numerator:
          type: integer
          description: Lo que cuenta un porcentaje.
        denominator:
          type: integer
          description: Entre qué se divide un porcentaje.
        sampleCount:
          type: integer
          description: Cuántas observaciones respaldan la cifra.
        caveats:
          type: array
          items:
            type: string
          description: >-
            Límites de la cifra, legibles por máquina, por ejemplo
            wall_clock_hours_no_business_calendar.
        timezone:
          type: string
        asOf:
          type: string
          format: date-time
          description: Cuándo se calculó la métrica.
        freshness:
          type: string
          enum:
            - live
        evidenceId:
          type: string
          description: >-
            Un descriptor estable de la métrica y sus filtros, para el
            drill-down y la cita.
        truncated:
          type: boolean
          description: >-
            true cuando una lectura acotada alcanzó su tope: el valor es un
            límite inferior.
        filters:
          type: object
          additionalProperties:
            type: string
        currency:
          type: string
        period:
          type: object
          additionalProperties: false
          required:
            - from
            - to
          properties:
            from:
              type: string
            to:
              type: string
    ProblemDetails:
      type: object
      additionalProperties: false
      required:
        - type
        - title
        - status
        - detail
        - instance
        - code
        - requestId
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
          minimum: 400
          maximum: 599
        detail:
          type: string
        instance:
          type: string
        code:
          type: string
        requestId:
          type: string
  securitySchemes:
    apiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: opaque
      description: >-
        Clave de API opaca mvy_test_ enviada como token Bearer. El servidor
        deriva de ella exactamente una clínica dental; la ruta nunca lleva un
        selector de clínica dental.

````

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