Akeda Dashboard metrics API

openapi: 3.2.0
info:
  title: Akeda ERP Client Dashboard metrics API
  version: 0.21.0-core-public
  summary: Проверяемый публичный контракт Go API Akeda ERP
  license:
    name: Proprietary
    identifier: LicenseRef-Akeda-Proprietary
  description: 'Этот контракт описывает API Akeda ERP. Полный исходный файл используют

    проверки живых Go-маршрутов, внутренние клиенты и реестр MCP. Скачиваемый

    клиентский контракт в `/docs` содержит только отобранные внешние методы;

    административные методы кабинета показаны отдельно после входа, а

    платформенные операторские методы остаются во внутреннем источнике.

    Стадия `public` означает обещание совместимости; `preview` допускает

    изменение формы. Аудитория, стадия и `security` — разные признаки:

    наличие метода в полном файле само по себе не выдаёт вызывающему право.

    Сервер отдельно проверяет тип токена, кабинет, scope и права на запись.

    Актуальные числа покрытия берите из генерируемой карты маршрутов и

    каталога покрытия, а не из описательного текста.'
servers:
- url: https://erp.akeda.ru
  description: PROD
security:
- erpUserToken: []
- tenantApiKey: []
- mcpOAuth:
  - akeda:delegate
tags:
- name: Dashboard metrics
paths:
  /api/v1/dashboard/metrics:
    get:
      tags:
      - Dashboard metrics
      operationId: dashboardListMetrics
      summary: Получить доступные показатели
      description: Каталог серверных показателей для снимков и подписных сводок, объявленных модулями-владельцами. Нужны dashboard:read, включённый модуль-владелец и актуальное право сотрудника читать его данные. Показатели считают службы владельцев; клиент и модель не создают свои формулы. Пока этот каталог не перечисляет все настраиваемые карточки веб-дашборда; для остальных сценариев используются API модулей-владельцев. Каталог не содержит учётных фактов.
      x-akeda-module: dashboard
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: dashboard:read
      security:
      - erpUserToken: []
      - mcpOAuth:
        - akeda:delegate
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      responses:
        '200':
          description: Каталог доступных показателей
          content:
            application/json:
              schema:
                type: object
                required:
                - count
                - results
                properties:
                  count:
                    type: integer
                    minimum: 0
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/DashboardMetricDefinition'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v1/dashboard/metrics/{id}/snapshot:
    get:
      tags:
      - Dashboard metrics
      operationId: dashboardGetMetricSnapshot
      summary: Рассчитать снимок показателя
      description: Готовый результат владельца за from/to с отбором юрлица и проекта. Деньги передаются строками с валютой; пустая величина неизвестна. as_of означает время расчёта, а не свежесть выгрузки внешнего поставщика. Ответ ограничен форматом карточки, а не заменяет полный отчёт. До расчёта и выдачи повторно проверяются текущий доступ сотрудника к модулю-владельцу и подключение этого модуля. Токен виджета открывает только эту витрину и не выдаёт сотруднику новых прав.
      x-akeda-module: dashboard
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: dashboard:read
      security:
      - erpUserToken: []
      - mcpOAuth:
        - akeda:delegate
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: from
        in: query
        required: true
        schema:
          type: string
          format: date
      - name: to
        in: query
        required: true
        schema:
          type: string
          format: date
      - name: company
        in: query
        schema:
          $ref: '#/components/schemas/UUID'
      - name: project
        in: query
        schema:
          $ref: '#/components/schemas/UUID'
      responses:
        '200':
          description: Снимок показателя
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardMetricSnapshot'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v1/dashboard/metrics/{id}/explain:
    get:
      tags:
      - Dashboard metrics
      operationId: dashboardExplainMetric
      summary: Объяснить число показателя
      description: Разложение показателя тем же расчётом владельца, что и снимок, за from/to с отбором юрлица и проекта. parts — слагаемые величины со знаком и пояснением, omitted — сколько слагаемых не вошло по пределу; issues — где цифра неполна или расходится (минус на складе, площадка не ответила, продажа без себестоимости, просроченный этап) с расшифровкой; sources — MCP-инструменты только чтения с аргументами и экран раздела, которыми открываются документы и движения за числом. Показатель без признака explainable в каталоге отвечает 404 dashboard_metric_not_explained. Доступ проверяется так же, как у снимка, в области права владельца показателя.
      x-akeda-module: dashboard
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: dashboard:read
      security:
      - erpUserToken: []
      - mcpOAuth:
        - akeda:delegate
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: from
        in: query
        required: true
        schema:
          type: string
          format: date
      - name: to
        in: query
        required: true
        schema:
          type: string
          format: date
      - name: company
        in: query
        schema:
          $ref: '#/components/schemas/UUID'
      - name: project
        in: query
        schema:
          $ref: '#/components/schemas/UUID'
      responses:
        '200':
          description: Разложение показателя
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardMetricExplanation'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    DashboardMetricDefinition:
      type: object
      required:
      - id
      - module
      - template
      - title
      - description
      - deeplink
      - explainable
      - rules
      properties:
        id:
          type: string
        module:
          type: string
        template:
          type: string
          enum:
          - amount
          - trend
          - rows
          - tiles
          - bars
          - table
        title:
          type: string
        description:
          type: string
        deeplink:
          type: string
        explainable:
          type: boolean
          description: 'Владелец раскладывает показатель на слагаемые: /api/v1/dashboard/metrics/{id}/explain'
        rules:
          type: array
          description: Правила сторожа, которые владелец находит кодом в объяснении показателя
          items:
            type: object
            required:
            - key
            - title
            properties:
              key:
                type: string
              title:
                type: string
    Error:
      type: object
      additionalProperties: false
      required:
      - detail
      properties:
        detail:
          type: string
          description: One human sentence in the request language (Accept-Language, echoed as Content-Language)
        code:
          type: string
          description: Stable module error code when the endpoint defines one
        field:
          type: string
          description: Request body path of the field the refusal is about, e.g. content.commercial.amount or due_date; present when the endpoint names the field
        reason:
          type: string
          description: Machine code of the field refusal reason, e.g. required, format, total_mismatch; present together with field when the endpoint defines reasons
        request_id:
          type: string
          format: uuid
          description: Case id. Always present on 5xx and on any error produced by the server itself; the same value is returned in the X-Request-ID header and recorded in the access log and the incident. Quote it to support instead of the cause, which the response never carries.
    DashboardMetricExplanation:
      type: object
      required:
      - id
      - title
      - value
      - currency
      - formula
      - parts
      - omitted
      - issues
      - sources
      - as_of
      - deeplink
      properties:
        id:
          type: string
        title:
          type: string
        value:
          type: string
        currency:
          type: string
        formula:
          type: string
          description: Как величина складывается из слагаемых
        parts:
          type: array
          maxItems: 12
          items:
            type: object
            required:
            - label
            - value
            - note
            - tone
            properties:
              label:
                type: string
              value:
                type: string
              note:
                type: string
              tone:
                type: string
                enum:
                - ''
                - positive
                - negative
        omitted:
          type: integer
          minimum: 0
          description: Сколько слагаемых не вошло в parts по пределу
        issues:
          type: array
          maxItems: 8
          items:
            type: object
            required:
            - text
            - value
            - rule
            - source
            properties:
              text:
                type: string
              value:
                type: string
              rule:
                type: string
                description: Ключ правила сторожа; пусто — расхождение поясняет число без тревоги
              source:
                oneOf:
                - $ref: '#/components/schemas/DashboardMetricExplanationSource'
                - type: 'null'
        sources:
          type: array
          maxItems: 6
          items:
            $ref: '#/components/schemas/DashboardMetricExplanationSource'
        as_of:
          type: string
          format: date-time
        deeplink:
          type: string
    DashboardMetricSnapshot:
      type: object
      required:
      - id
      - template
      - title
      - value
      - currency
      - caption
      - as_of
      - deeplink
      - points
      - rows
      - tiles
      - bars
      - columns
      - table
      properties:
        id:
          type: string
        template:
          type: string
          enum:
          - amount
          - trend
          - rows
          - tiles
          - bars
          - table
        title:
          type: string
        value:
          type: string
        currency:
          type: string
        caption:
          type: string
        as_of:
          type: string
          format: date-time
        deeplink:
          type: string
        points:
          type: array
          maxItems: 60
          items:
            type: object
            required:
            - label
            - value
            properties:
              label:
                type: string
              value:
                type: string
        rows:
          type: array
          maxItems: 5
          items:
            type: object
            required:
            - title
            - value
            - detail
            properties:
              title:
                type: string
              value:
                type: string
              detail:
                type: string
        tiles:
          type: array
          maxItems: 6
          items:
            type: object
            required:
            - label
            - value
            - note
            - tone
            properties:
              label:
                type: string
              value:
                type: string
              note:
                type: string
              tone:
                type: string
                enum:
                - ''
                - positive
                - negative
        bars:
          type: array
          maxItems: 6
          items:
            type: object
            required:
            - title
            - value
            - note
            - fill
            - tone
            properties:
              title:
                type: string
              value:
                type: string
              note:
                type: string
              fill:
                type: number
                minimum: 0
                maximum: 1
              tone:
                type: string
                enum:
                - ''
                - positive
                - negative
        columns:
          type: array
          maxItems: 3
          items:
            type: object
            required:
            - title
            properties:
              title:
                type: string
        table:
          type: array
          maxItems: 8
          items:
            type: object
            required:
            - title
            - cells
            properties:
              title:
                type: string
              cells:
                type: array
                maxItems: 3
                items:
                  type: object
                  required:
                  - value
                  - tone
                  properties:
                    value:
                      type: string
                    tone:
                      type: string
                      enum:
                      - ''
                      - positive
                      - negative
    DashboardMetricExplanationSource:
      type: object
      required:
      - title
      - tool
      - args
      - deeplink
      properties:
        title:
          type: string
        tool:
          type: string
          description: MCP-инструмент только чтения; пусто — расшифровка только экраном
        args:
          type: object
          additionalProperties:
            type: string
        deeplink:
          type: string
    UUID:
      type: string
      format: uuid
  responses:
    BadRequest:
      description: Некорректный запрос или нарушение бизнес-правила
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Сессия, ключ или кабинет не подтверждены
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Текущая роль не имеет требуемого права
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Запись не найдена или не видима текущему пользователю
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    TenantHeader:
      name: X-Tenant
      in: header
      required: true
      description: Slug выбранного кабинета; кабинет не является юрлицом
      schema:
        type: string
        minLength: 1
  securitySchemes:
    erpUserToken:
      type: http
      scheme: bearer
      bearerFormat: go_session
      description: Пользовательский ERP token, полученный через ORY Kratos session bridge
    tenantApiKey:
      type: apiKey
      in: header
      name: X-Api-Key
      description: Tenant-scoped сервисный API-ключ Akeda
    installationToken:
      type: http
      scheme: bearer
      bearerFormat: akeda_installation_token
      description: 'Краткосрочный токен установки приложения (`ai_…`). Выдаёт его человек: публичной двери обмена учётных данных на токен нет и не будет, пока нет брокера долгой половины секрета, асимметричного подтверждения и ограничителя с аудитом неудачных попыток. Токен принимается и в заголовке X-Api-Key, и живёт минуты — вместо показа его ротируют'
    developerSessionToken:
      type: http
      scheme: bearer
      bearerFormat: akeda_developer_session
      description: 'Сессия аккаунта разработчика (`ad_…`). Своя схема, а не пользовательский токен ERP: у разработчика нет кабинета, роли и прав, а хеш этого токена лежит в отдельном хранилище — на кабинетных маршрутах он не находится ничем. Выдаёт его обмен одноразовой ссылки из письма; пароля в этом контуре нет вовсе'
    developerAppKey:
      type: http
      scheme: bearer
      bearerFormat: akeda_developer_app_key
      description: 'Учётные данные приложения (`adk_…`) — это машина конвейера издателя, а не человек. Ключ привязан к ОДНОМУ приложению внешним ключом, и достижимая им поверхность — маршруты `/api/v1/developer` этого приложения. Обменять его на токен установки нельзя: такой двери нет, и ни одного маршрута к данным кабинета за ним не существует. Выпуск, ротацию и отзыв учётных данных этот ключ не выполняет: ключ, умеющий выпустить следующий ключ, не отзывается никогда. Значение показывается один раз, при выдаче; в хранилище лежит хеш'
    mcpOAuth:
      type: oauth2
      description: OAuth 2.1 delegation для MCP; кабинетные права проверяются на каждом вызове
      flows:
        authorizationCode:
          authorizationUrl: https://erp.akeda.ru/oauth2/authorize
          tokenUrl: https://erp.akeda.ru/oauth2/token
          scopes:
            akeda:delegate: Делегировать текущие пользовательские права MCP-подключению
x-akeda-contract-coverage:
- dashboard-metrics
- tasks-lifecycle
- tasks-collaboration
- tasks-workflow
- tasks-organization
- tasks-automation
- tasks-planning
- tasks-project-hub
- tasks-files
- calendar-events
- calendar-availability
- calendar-booking
- calendar-notifications
- calendar-connectors
- chat-conversations
- chat-messages
- chat-receipts
- chat-mentions
- chat-realtime
- core-directories
- core-folders
- core-contacts
- core-products
- core-documents
- core-orders
- core-registers
- core-accounting
- core-ledger
- core-items
- core-employees
- core-employee-operations
- core-currency-rates
- core-preferences
- core-ui-state
- core-external-refs
- core-product-imports
- core-product-exports
- core-gl-opening-imports
- core-reference
- core-change-feed
- finance-accounts
- finance-statements
- finance-transactions
- finance-connectors
- finance-connector-sync
- finance-requisites
- finance-counterparty-terms
- finance-operations
- finance-settlements
- finance-trade
- finance-exchange
- finance-imports
- finance-payment-calendar
- finance-pnl-layouts
- finance-registers
- finance-reports
- crm-pipelines
- crm-deals
- crm-leads
- crm-customers
- crm-links
- crm-inbox
- crm-automation
- crm-analytics
- knowledge-spaces
- knowledge-pages
- knowledge-access
- knowledge-files
- knowledge-search
- files-drives
- files-content
- files-access
- files-uploads
- files-shares
- stock-documents
- stock-inventory
- stock-warehouses
- stock-handling-units
- stock-batches
- stock-product-units
- stock-references
- stock-imports
- stock-exports
- stock-reports
- stock-valuation
- stock-reorder-rules
- stock-settings
- stock-purchasing
- marking-settings
- marking-connections
- marking-products
- marking-codes
- marking-labels
- marking-stock-codes
- marking-orders
- marking-gismt-documents
- marking-boxes
- marketplace-stores
- marketplace-ozon
- marketplace-wildberries
- marketplace-yandex
- marketplace-product-groups
- marketplace-accounting
- marketplace-catalog
- settings-companies
- settings-roles
- settings-members
- settings-fields
- settings-api-keys
- finance-payroll
- finance-report-details
- knowledge-tags
- knowledge-revisions
- knowledge-approval
- chat-attachments
- chat-reactions
- chat-folders
- platform-apps
- platform-app-installations
- platform-app-tokens
- platform-app-deliveries
- platform-app-publishers
- platform-app-publication
- platform-app-rollouts
- platform-app-runtime
- platform-app-access
- platform-app-blocks
- platform-demo-data
- billing-usage
- platform-analytics
- finance-staffing
- platform-tenants
- platform-users
- platform-access
- platform-mcp-publication
- platform-incidents
- platform-health
- settings-apps
- docflow-connections
- docflow-mirror
- docflow-signing
- docflow-actions
- docflow-outgoing
- docflow-intake
- docflow-flow
- docflow-approvals
- docflow-flow-accounting
- mail-accounts
- mail-folders
- mail-messages
- mail-rules
- mail-outbound
- mail-attachments
- billing-plans
- billing-subscriptions
- billing-invoices
- billing-analytics
- settings-subscription
- billing-payments
- billing-public
x-akeda-docs-path: /docs
x-akeda-default-release-stage: internal
x-akeda-default-audience: operator