> ## 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 efficency ## OpenAPI ````yaml /openapi/metrics.json get /v1/crm/metrics/efficency/ 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/efficency/: get: tags: - efficency summary: Get efficency operationId: efficency_list parameters: - in: query name: car__isnull schema: type: boolean - in: query name: category schema: type: integer - in: query name: category__in schema: type: array items: type: integer description: Несколько значений могут быть разделены запятыми. explode: false style: form - in: query name: disable__isnull schema: type: boolean - in: query name: disable__method schema: type: integer title: Способ enum: - 0 - 1 - 2 description: |- * `0` - удалить * `1` - Архив * `2` - Списано - in: query name: disabled schema: type: boolean - in: query name: end_at schema: type: string format: date description: >- Конец отчётного периода, включительно. Дата (ГГГГ-ММ-ДД) или момент времени, от которого берётся дата. - in: query name: exclude_ids schema: type: array items: type: integer description: Несколько значений могут быть разделены запятыми. explode: false style: form - in: query name: filter_key schema: type: string - in: query name: fleet_status schema: type: string - in: query name: free schema: type: boolean - in: query name: group schema: type: integer - in: query name: group__in schema: type: array items: type: integer description: Несколько значений могут быть разделены запятыми. explode: false style: form - in: query name: has_sublease schema: type: boolean - in: query name: id schema: type: integer - in: query name: id__in schema: type: array items: type: integer description: Несколько значений могут быть разделены запятыми. explode: false style: form - 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: integer - in: query name: rental_point__in schema: type: array items: type: integer description: Несколько значений могут быть разделены запятыми. explode: false style: form - in: query name: request schema: type: number - in: query name: saleable schema: type: boolean - name: search required: false in: query description: A search term. schema: type: string - in: query name: start_at schema: type: string format: date description: >- Начало отчётного периода, включительно. Дата (ГГГГ-ММ-ДД) или момент времени, от которого берётся дата. - in: query name: state schema: type: integer - in: query name: state__in schema: type: array items: type: integer description: Несколько значений могут быть разделены запятыми. explode: false style: form - in: query name: status schema: type: number - in: query name: sublease_user schema: type: number - in: query name: sublease_user__in schema: type: array items: type: number description: Несколько значений могут быть разделены запятыми. explode: false style: form - in: query name: sublease_user__isnull schema: type: boolean - in: query name: type schema: type: number - in: query name: unique_id schema: type: string - in: query name: unique_id__in schema: type: array items: type: string description: Несколько значений могут быть разделены запятыми. explode: false style: form - $ref: '#/components/parameters/TenantId' responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedInventoryEfficencyList' description: '' security: - jwtAuth: [] components: parameters: TenantId: name: X-Tenant-Id in: header required: false schema: type: integer description: >- Компания, в контексте которой выполняется запрос — её id из `GET /v1/tenant/`. Пользователь должен состоять в этой компании: чужой id доступа к данным не даёт. Без заголовка компания определяется по домену запроса. schemas: PaginatedInventoryEfficencyList: 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/InventoryEfficency' InventoryEfficency: type: object properties: id: type: integer readOnly: true group: type: integer nullable: true title: Группа инвентаря name: type: string title: Название maxLength: 255 unique_id: type: string nullable: true title: Артикул maxLength: 255 category: type: integer nullable: true title: Категория image: type: string format: uri nullable: true title: Изображение extra: title: Доп. данные subleases: type: array items: $ref: '#/components/schemas/InventorySublease' readOnly: true state: type: integer nullable: true title: Состояние disabled: nullable: true oneOf: - $ref: '#/components/schemas/DisabledEnum' - $ref: '#/components/schemas/NullEnum' rental_point: type: integer nullable: true title: Точка проката car: allOf: - $ref: '#/components/schemas/InventoryCar' readOnly: true revenue: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ default: '0.00' revenue_lost: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ default: '0.00' efficency: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ default: '0.00' days: type: integer days_idle: type: integer total: type: integer required: - car - days - days_idle - id - name - subleases - total InventorySublease: type: object properties: id: type: integer readOnly: true inventory: type: integer title: Инвентарь user: type: integer title: Владелец субаренды percent: type: string format: decimal pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ title: Процент субаренды start_at: type: string format: date-time nullable: true title: Начало периода end_at: type: string format: date-time nullable: true title: Конец периода is_current: type: boolean readOnly: true created_at: type: string format: date-time readOnly: true title: Создан required: - created_at - id - inventory - is_current - percent - user DisabledEnum: enum: - 0 - 1 - 2 type: integer description: |- * `0` - удалить * `1` - Архив * `2` - Списано NullEnum: enum: - null InventoryCar: type: object properties: id: type: integer readOnly: true type: $ref: '#/components/schemas/InventoryCarTypeEnum' brand: type: string nullable: true maxLength: 255 model: type: string nullable: true maxLength: 255 number: type: string nullable: true maxLength: 255 tech_passport: type: string nullable: true maxLength: 255 serial: type: string nullable: true maxLength: 255 vin: type: string nullable: true maxLength: 18 extra: {} required: - id InventoryCarTypeEnum: enum: - CAR - SCOOTER - MOTORCYCLE type: string description: |- * `CAR` - Автомобиль * `SCOOTER` - Электросамокат * `MOTORCYCLE` - Мотоцикл/Мопед securitySchemes: jwtAuth: type: http scheme: bearer bearerFormat: JWT ````