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



## OpenAPI

````yaml /openapi/metrics.json get /v1/crm/metrics/funnels/
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/funnels/:
    get:
      tags:
        - funnels
      summary: Get funnels
      operationId: funnels_retrieve
      parameters:
        - in: query
          name: end_at
          schema:
            type: string
            format: date
          description: >-
            Конец отчётного периода, включительно. Дата (ГГГГ-ММ-ДД) или момент
            времени, от которого берётся дата.
        - in: query
          name: funnel
          schema:
            type: number
        - in: query
          name: start_at
          schema:
            type: string
            format: date
          description: >-
            Начало отчётного периода, включительно. Дата (ГГГГ-ММ-ДД) или момент
            времени, от которого берётся дата.
        - $ref: '#/components/parameters/TenantId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsFunnelView'
          description: ''
      security:
        - jwtAuth: []
components:
  parameters:
    TenantId:
      name: X-Tenant-Id
      in: header
      required: false
      schema:
        type: integer
      description: >-
        Компания, в контексте которой выполняется запрос — её id из `GET
        /v1/tenant/`. Пользователь должен состоять в этой компании: чужой id
        доступа к данным не даёт. Без заголовка компания определяется по домену
        запроса.
  schemas:
    MetricsFunnelView:
      type: object
      properties:
        count:
          type: integer
        count_period:
          type: integer
        loaded:
          $ref: '#/components/schemas/StageLoadede'
        users:
          type: array
          items:
            $ref: '#/components/schemas/UserSpeed'
        stages:
          type: array
          items:
            $ref: '#/components/schemas/StageSpeed'
      required:
        - count
        - count_period
        - loaded
        - stages
        - users
    StageLoadede:
      type: object
      properties:
        stage:
          type: integer
        count:
          type: integer
      required:
        - count
        - stage
    UserSpeed:
      type: object
      properties:
        user:
          type: integer
        duration:
          type: string
      required:
        - duration
        - user
    StageSpeed:
      type: object
      properties:
        stage:
          type: integer
        duration:
          type: string
      required:
        - duration
        - stage
  securitySchemes:
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````