> ## 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. # Obter o resumo gerencial > Lê o resumo gerencial reproduzível, diário ou semanal: as métricas operacionais determinísticas reunidas em um único compêndio em que cada número se liga à sua métrica de origem e ao seu id de evidência. Requer analytics:read. Apenas contagens, quantidades e durações; sem custo nem valor. Determinístico; calculado ao vivo sobre os dados da clínica odontológica. ## OpenAPI ````yaml /openapi.pt.json get /v1/analytics/briefing 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/briefing: get: tags: - Análises summary: Obter o resumo gerencial description: >- Lê o resumo gerencial reproduzível, diário ou semanal: as métricas operacionais determinísticas reunidas em um único compêndio em que cada número se liga à sua métrica de origem e ao seu id de evidência. Requer analytics:read. Apenas contagens, quantidades e durações; sem custo nem valor. Determinístico; calculado ao vivo sobre os dados da clínica odontológica. operationId: getAnalyticsBriefing parameters: - name: period in: query required: false description: A frequência do resumo gerencial; o padrão é `daily`. schema: type: string enum: - daily - weekly - name: Accept-Language in: header required: false description: >- O idioma dos rótulos de cada número: en, es ou pt (padrão en). As chaves de métrica, dimensões, unidades, valores e ids de evidência nunca mudam com ele. schema: type: string responses: '200': description: O resumo gerencial. content: application/json: schema: $ref: '#/components/schemas/Briefing' 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 '400': description: O período não é daily nem weekly. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' 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: Briefing: type: object additionalProperties: false required: - metric - definition - period - timezone - asOf - freshness - evidenceId - truncated - figures properties: metric: type: string definition: type: string description: A definição legível do resumo 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 quando alguma métrica composta atingiu o teto de leitura: um número é um limite 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: 'A métrica de origem deste número: o link para o drill-down.' dimension: type: string description: >- A subchave de uma métrica com várias linhas (uma faixa de idade, uma etapa do ciclo); omitida em um número escalar. label: type: string value: type: - number - 'null' description: O número; null quando a métrica de origem não teve amostra. unit: type: string evidenceId: type: string description: >- O id de evidência da métrica de origem: o identificador reproduzível para o drill-down (FR-MGT-04). 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.