> ## 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/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/general/:
    get:
      tags:
        - general
      summary: Get general
      operationId: general_list
      parameters:
        - in: query
          name: client
          schema:
            type: number
        - in: query
          name: date
          schema:
            type: string
            format: date
        - in: query
          name: date__gte
          schema:
            type: string
            format: date
        - in: query
          name: date__lte
          schema:
            type: string
            format: date
        - name: ordering
          required: false
          in: query
          description: Which field to use when ordering the results.
          schema:
            type: string
        - name: page
          required: false
          in: query
          description: A page number within the paginated result set.
          schema:
            type: integer
        - name: pageSize
          required: false
          in: query
          description: Number of results to return per page.
          schema:
            type: integer
        - in: query
          name: rental_point
          schema:
            type: number
        - in: query
          name: type
          schema:
            type: string
            enum:
              - delivery
              - inventory
              - maintenance
              - penalty
              - request
              - sale
              - service
              - workshop
              - workshop_expense
          description: |-
            * `request` - Аренда
            * `inventory` - Инвентарь
            * `service` - Услуга
            * `delivery` - Доставка
            * `penalty` - Штраф
            * `workshop` - Сервис
            * `workshop_expense` - Сервис (Расход)
            * `maintenance` - Обслуживание
            * `sale` - Продажа
        - $ref: '#/components/parameters/TenantId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedMetricsGeneralList'
          description: ''
      security:
        - jwtAuth: []
components:
  parameters:
    TenantId:
      name: X-Tenant-Id
      in: header
      required: false
      schema:
        type: integer
      description: >-
        Компания, в контексте которой выполняется запрос — её id из `GET
        /v1/tenant/`. Пользователь должен состоять в этой компании: чужой id
        доступа к данным не даёт. Без заголовка компания определяется по домену
        запроса.
  schemas:
    PaginatedMetricsGeneralList:
      type: object
      required:
        - count
        - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/MetricsGeneral'
    MetricsGeneral:
      type: object
      properties:
        date:
          type: string
          format: date
        request_count:
          type: integer
        service_count:
          type: integer
        delivery_count:
          type: integer
        penalty_count:
          type: integer
        workshop_count:
          type: integer
        workshop_expense_count:
          type: integer
        sale_count:
          type: integer
        request_amount:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
        service_amount:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
        delivery_amount:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
        penalty_amount:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
        workshop_amount:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
        workshop_expense_amount:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
        maintenance_amount:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
        sale_amount:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
        prediction:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
        profit:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
      required:
        - date
        - delivery_amount
        - delivery_count
        - maintenance_amount
        - penalty_amount
        - penalty_count
        - prediction
        - profit
        - request_amount
        - request_count
        - sale_amount
        - sale_count
        - service_amount
        - service_count
        - workshop_amount
        - workshop_count
        - workshop_expense_amount
        - workshop_expense_count
  securitySchemes:
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````