> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yume.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Get general



## OpenAPI

````yaml /openapi/metrics.json get /v1/crm/metrics/bonus/general/
openapi: 3.0.3
info:
  title: Yume API — Аналитика
  version: 1.0.0
  description: Системные метрики, аналитика и отчётность.
servers:
  - url: https://api.yume.cloud
    description: Production
  - url: https://api.stage.yume.cloud
    description: Stage
security: []
paths:
  /v1/crm/metrics/bonus/general/:
    get:
      tags:
        - bonus
      summary: Get general
      operationId: bonus_general_retrieve
      parameters:
        - in: query
          name: end_at
          schema:
            type: string
            format: date
          description: >-
            Конец отчётного периода, включительно. Дата (ГГГГ-ММ-ДД) или момент
            времени, от которого берётся дата.
        - in: query
          name: start_at
          schema:
            type: string
            format: date
          description: >-
            Начало отчётного периода, включительно. Дата (ГГГГ-ММ-ДД) или момент
            времени, от которого берётся дата.
        - $ref: '#/components/parameters/TenantId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsBonusGeneral'
          description: ''
      security:
        - jwtAuth: []
components:
  parameters:
    TenantId:
      name: X-Tenant-Id
      in: header
      required: false
      schema:
        type: integer
      description: >-
        Компания, в контексте которой выполняется запрос — её id из `GET
        /v1/tenant/`. Пользователь должен состоять в этой компании: чужой id
        доступа к данным не даёт. Без заголовка компания определяется по домену
        запроса.
  schemas:
    MetricsBonusGeneral:
      type: object
      properties:
        sum:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
        delivered:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
        received:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
      required:
        - delivered
        - received
        - sum
  securitySchemes:
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````