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

# Get the management briefing

> Reads the reproducible daily or weekly management briefing — the deterministic operational metrics composed into a single digest where every figure links to its source metric and evidence id. Requires analytics:read. Counts, quantities and durations only; no cost or value. Deterministic; computed live over the workspace data.



## OpenAPI

````yaml /openapi.en.json get /v1/analytics/briefing
openapi: 3.1.0
info:
  description: >-
    The Muveya public developer API: opaque-API-key-authenticated,
    tenant-scoped, read-only /v1 resources. One rate-limit budget per key.
  title: Muveya Developer API
  version: 0.1.0
servers:
  - description: Production
    url: https://api.muveya.com
security: []
tags:
  - name: API key
  - name: Clinics
  - name: Warehouses
  - name: Catalog
  - name: Inventory
  - name: Orders
  - name: Fulfillments
  - name: Analytics
paths:
  /v1/analytics/briefing:
    get:
      tags:
        - Analytics
      summary: Get the management briefing
      description: >-
        Reads the reproducible daily or weekly management briefing — the
        deterministic operational metrics composed into a single digest where
        every figure links to its source metric and evidence id. Requires
        analytics:read. Counts, quantities and durations only; no cost or value.
        Deterministic; computed live over the workspace data.
      operationId: getAnalyticsBriefing
      parameters:
        - name: period
          in: query
          required: false
          description: The briefing cadence; defaults to `daily`.
          schema:
            type: string
            enum:
              - daily
              - weekly
        - name: Accept-Language
          in: header
          required: false
          description: >-
            The language of every figure label: en, es or pt (default en).
            Metric keys, dimensions, units, values and evidence ids never change
            with it.
          schema:
            type: string
      responses:
        '200':
          description: The management briefing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Briefing'
          headers:
            X-RateLimit-Limit:
              description: The per-key request budget for the current window.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Remaining:
              description: Requests left in the current window (0 when exhausted).
              schema:
                type: integer
                minimum: 0
            X-RateLimit-Reset:
              description: Seconds until the current window resets.
              schema:
                type: integer
                minimum: 1
            RateLimit:
              description: >-
                IETF draft budget snapshot, e.g. "limit=120, remaining=119,
                reset=60".
              schema:
                type: string
            RateLimit-Policy:
              description: IETF draft policy, e.g. "120;w=60" (limit;window-seconds).
              schema:
                type: string
        '400':
          description: The period is not one of daily or weekly.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          headers:
            X-RateLimit-Limit:
              description: The per-key request budget for the current window.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Remaining:
              description: Requests left in the current window (0 when exhausted).
              schema:
                type: integer
                minimum: 0
            X-RateLimit-Reset:
              description: Seconds until the current window resets.
              schema:
                type: integer
                minimum: 1
            RateLimit:
              description: >-
                IETF draft budget snapshot, e.g. "limit=120, remaining=119,
                reset=60".
              schema:
                type: string
            RateLimit-Policy:
              description: IETF draft policy, e.g. "120;w=60" (limit;window-seconds).
              schema:
                type: string
        '401':
          description: >-
            The API key is missing, invalid, revoked, expired, or bound to a
            suspended workspace.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: The API key lacks the scope this route requires.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: The API key exceeded its rate limit for the current window.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          headers:
            Retry-After:
              description: Positive delta-seconds until another request is allowed.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Limit:
              description: The per-key request budget for the current window.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Remaining:
              description: Requests left in the current window (0 when exhausted).
              schema:
                type: integer
                minimum: 0
            X-RateLimit-Reset:
              description: Seconds until the current window resets.
              schema:
                type: integer
                minimum: 1
            RateLimit:
              description: >-
                IETF draft budget snapshot, e.g. "limit=120, remaining=119,
                reset=60".
              schema:
                type: string
            RateLimit-Policy:
              description: IETF draft policy, e.g. "120;w=60" (limit;window-seconds).
              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: The human-readable definition of the briefing.
        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 when any composed metric hit its scan cap: a figure is a lower
            bound.
        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: The source metric this figure came from — the drill-down link.
        dimension:
          type: string
          description: >-
            The sub-key of a multi-row metric (an age band, a cycle stage);
            omitted for a scalar figure.
        label:
          type: string
        value:
          type:
            - number
            - 'null'
          description: The figure; null when the source metric had no sample.
        unit:
          type: string
        evidenceId:
          type: string
          description: >-
            The source metric evidence id — the reproducible drill-down handle
            (FR-MGT-04).
  securitySchemes:
    apiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: opaque
      description: >-
        Opaque mvy_test_ API key sent as a Bearer token. It derives exactly one
        workspace server-side; the path never carries a workspace selector.

````

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