> ## 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.

# Comparar clínicas

> Compara as unidades da clínica odontológica por volume de pedidos (total e pendentes de aprovação), com a definição da métrica à vista. Apenas contagens: o valor dos pedidos é omitido a menos que a chave tenha o escopo de valor (nenhuma na v1). Requer analytics:read. Determinístico; calculado ao vivo sobre os dados da clínica odontológica.



## OpenAPI

````yaml /openapi.pt.json get /v1/analytics/clinics/comparison
openapi: 3.1.0
info:
  description: >-
    A API pública para desenvolvedores da Muveya: recursos /v1 somente leitura,
    limitados a um tenant e autenticados com uma chave de API opaca. Um
    orçamento de solicitações por chave.
  title: API para desenvolvedores da Muveya
  version: 0.1.0
servers:
  - description: Produção
    url: https://api.muveya.com
security: []
tags:
  - name: Chave de API
  - name: Clínicas
  - name: Depósitos
  - name: Catálogo
  - name: Inventário
  - name: Pedidos
  - name: Entregas
  - name: Análises
paths:
  /v1/analytics/clinics/comparison:
    get:
      tags:
        - Análises
      summary: Comparar clínicas
      description: >-
        Compara as unidades da clínica odontológica por volume de pedidos (total
        e pendentes de aprovação), com a definição da métrica à vista. Apenas
        contagens: o valor dos pedidos é omitido a menos que a chave tenha o
        escopo de valor (nenhuma na v1). Requer analytics:read. Determinístico;
        calculado ao vivo sobre os dados da clínica odontológica.
      operationId: compareAnalyticsClinics
      responses:
        '200':
          description: A comparação de clínicas.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClinicComparison'
          headers:
            X-RateLimit-Limit:
              description: O orçamento de solicitações por chave na janela atual.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Remaining:
              description: Solicitações restantes na janela atual (0 quando esgotadas).
              schema:
                type: integer
                minimum: 0
            X-RateLimit-Reset:
              description: Segundos até a janela atual ser reiniciada.
              schema:
                type: integer
                minimum: 1
            RateLimit:
              description: >-
                Estado do orçamento de solicitações segundo o rascunho da IETF,
                por exemplo "limit=120, remaining=119, reset=60".
              schema:
                type: string
            RateLimit-Policy:
              description: >-
                Política segundo o rascunho da IETF, por exemplo "120;w=60"
                (limite;segundos da janela).
              schema:
                type: string
        '401':
          description: >-
            A chave de API está ausente, é inválida, foi revogada, expirou ou
            está vinculada a uma clínica odontológica suspensa.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: A chave de API não tem o escopo que esta rota exige.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: A chave de API excedeu seu limite de solicitações na janela atual.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          headers:
            Retry-After:
              description: >-
                Segundos (valor positivo) até que outra solicitação seja
                permitida.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Limit:
              description: O orçamento de solicitações por chave na janela atual.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Remaining:
              description: Solicitações restantes na janela atual (0 quando esgotadas).
              schema:
                type: integer
                minimum: 0
            X-RateLimit-Reset:
              description: Segundos até a janela atual ser reiniciada.
              schema:
                type: integer
                minimum: 1
            RateLimit:
              description: >-
                Estado do orçamento de solicitações segundo o rascunho da IETF,
                por exemplo "limit=120, remaining=119, reset=60".
              schema:
                type: string
            RateLimit-Policy:
              description: >-
                Política segundo o rascunho da IETF, por exemplo "120;w=60"
                (limite;segundos da janela).
              schema:
                type: string
      security:
        - apiKeyBearer: []
components:
  schemas:
    ClinicComparison:
      type: object
      additionalProperties: false
      required:
        - metric
        - definition
        - unit
        - timezone
        - asOf
        - freshness
        - evidenceId
        - truncated
        - filters
        - clinics
      properties:
        metric:
          type: string
        definition:
          type: string
          description: >-
            A definição legível da métrica de comparação (sempre à vista, nunca
            implícita).
        unit:
          type: string
        timezone:
          type: string
        asOf:
          type: string
          format: date-time
        freshness:
          type: string
          enum:
            - live
        evidenceId:
          type: string
        truncated:
          type: boolean
          description: >-
            true quando a leitura de pedidos atingiu o teto: as contagens são um
            limite inferior.
        filters:
          type: object
          additionalProperties:
            type: string
        clinics:
          type: array
          items:
            $ref: '#/components/schemas/ClinicComparisonRow'
    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
    ClinicComparisonRow:
      type: object
      additionalProperties: false
      required:
        - clinicId
        - clinicName
        - clinicStatus
        - totalOrders
        - pendingApprovalOrders
      properties:
        clinicId:
          type: string
        clinicName:
          type: string
        clinicStatus:
          type: string
          enum:
            - active
            - inactive
        totalOrders:
          type: integer
        pendingApprovalOrders:
          type: integer
  securitySchemes:
    apiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: opaque
      description: >-
        Chave de API opaca mvy_test_ enviada como token Bearer. O servidor
        deriva dela exatamente uma clínica odontológica; o caminho nunca leva um
        seletor de clínica odontológica.

````

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