> ## 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 el resumen gerencial

> Lee el resumen gerencial reproducible, diario o semanal: las métricas operativas determinísticas reunidas en un solo compendio donde cada cifra enlaza con su métrica de origen y su id de evidencia. Requiere analytics:read. Solo conteos, cantidades y duraciones; sin costo ni valor. Determinístico; se calcula en vivo sobre los datos de la clínica dental.



## OpenAPI

````yaml /openapi.es.json get /v1/analytics/briefing
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/briefing:
    get:
      tags:
        - Analítica
      summary: Obtener el resumen gerencial
      description: >-
        Lee el resumen gerencial reproducible, diario o semanal: las métricas
        operativas determinísticas reunidas en un solo compendio donde cada
        cifra enlaza con su métrica de origen y su id de evidencia. Requiere
        analytics:read. Solo conteos, cantidades y duraciones; sin costo ni
        valor. Determinístico; se calcula en vivo sobre los datos de la clínica
        dental.
      operationId: getAnalyticsBriefing
      parameters:
        - name: period
          in: query
          required: false
          description: La frecuencia del resumen gerencial; por defecto `daily`.
          schema:
            type: string
            enum:
              - daily
              - weekly
        - name: Accept-Language
          in: header
          required: false
          description: >-
            El idioma de las etiquetas de cada cifra: en, es o pt (por defecto
            en). Las claves de métrica, dimensiones, unidades, valores e ids de
            evidencia nunca cambian con él.
          schema:
            type: string
      responses:
        '200':
          description: El resumen gerencial.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Briefing'
          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 período no es daily ni weekly.
          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:
    Briefing:
      type: object
      additionalProperties: false
      required:
        - metric
        - definition
        - period
        - timezone
        - asOf
        - freshness
        - evidenceId
        - truncated
        - figures
      properties:
        metric:
          type: string
        definition:
          type: string
          description: La definición legible del resumen gerencial.
        period:
          type: string
          enum:
            - daily
            - weekly
        timezone:
          type: string
        asOf:
          type: string
          format: date-time
        freshness:
          type: string
          enum:
            - live
        evidenceId:
          type: string
        truncated:
          type: boolean
          description: >-
            true cuando alguna métrica compuesta alcanzó su tope de lectura: una
            cifra es un límite inferior.
        figures:
          type: array
          items:
            $ref: '#/components/schemas/BriefingFigure'
    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
    BriefingFigure:
      type: object
      additionalProperties: false
      required:
        - metric
        - label
        - value
        - unit
        - evidenceId
      properties:
        metric:
          type: string
          description: 'La métrica de origen de esta cifra: el enlace para el drill-down.'
        dimension:
          type: string
          description: >-
            La subclave de una métrica de varias filas (un tramo de antigüedad,
            una etapa del ciclo); se omite en una cifra escalar.
        label:
          type: string
        value:
          type:
            - number
            - 'null'
          description: La cifra; null cuando la métrica de origen no tuvo muestra.
        unit:
          type: string
        evidenceId:
          type: string
          description: >-
            El id de evidencia de la métrica de origen: el identificador
            reproducible para el drill-down (FR-MGT-04).
  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.