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

# Get flow metrics

> Returns sends, conversions, conversion rate, and recovered revenue for the flow in the period, broken down by message node.



## OpenAPI

````yaml /openapi.en.json get /v1/flows/{flow_id}/metrics
openapi: 3.1.0
info:
  title: Bevits API
  version: 1.0.0
  description: >-
    Public read-only API for querying CRM, purchase, and automation data from a
    Bevits organization.
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.bevits.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: System
    description: API availability.
  - name: Identity
    description: Organization and API key identity.
  - name: Customers
    description: Customers and their relationships.
  - name: Segments
    description: Customer segments.
  - name: Purchases
    description: Purchases imported from integrations.
  - name: CRM data
    description: Tags and attribute definitions.
  - name: Automations
    description: Automation flows.
  - name: Campaigns
    description: Email campaigns.
paths:
  /v1/flows/{flow_id}/metrics:
    get:
      tags:
        - Automations
      summary: Get flow metrics
      description: >-
        Returns sends, conversions, conversion rate, and recovered revenue for
        the flow in the period, broken down by message node.
      operationId: getFlowMetrics
      parameters:
        - $ref: '#/components/parameters/FlowId'
        - $ref: '#/components/parameters/MetricsSince'
        - $ref: '#/components/parameters/MetricsUntil'
      responses:
        '200':
          $ref: '#/components/responses/FlowMetrics'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    FlowId:
      name: flow_id
      in: path
      required: true
      description: Public flow ID.
      schema:
        type: string
        pattern: ^flw_[A-Za-z0-9_-]+$
    MetricsSince:
      name: since
      in: query
      description: Start of the analyzed window. Defaults to 30 days ago.
      schema:
        type: string
        format: date-time
    MetricsUntil:
      name: until
      in: query
      description: End of the analyzed window. Defaults to the moment of the request.
      schema:
        type: string
        format: date-time
  responses:
    FlowMetrics:
      description: Flow metrics for the period.
      headers:
        ETag:
          $ref: '#/components/headers/ETag'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/FlowMetrics'
    InvalidRequest:
      description: Invalid route parameter.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Missing, invalid, expired, or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              type: authentication_error
              message: Invalid API key.
              request_id: req_07f6cdc3c20249d6afcd90b4
    NotFound:
      description: Resource does not exist or belongs to another organization.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ValidationError:
      description: A parameter failed validation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              type: validation_error
              message: Invalid query parameters.
              param: limit
              request_id: req_07f6cdc3c20249d6afcd90b4
    RateLimited:
      description: Request limit exceeded.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitErrorResponse'
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  headers:
    ETag:
      description: Content version identifier for conditional caching.
      schema:
        type: string
        example: '"v1-4ad31f5efb6b8f35"'
    RetryAfter:
      description: Seconds before retrying.
      schema:
        type: integer
        minimum: 1
    RateLimitLimit:
      description: Total limit for the current window.
      schema:
        type: integer
        example: 600
    RateLimitRemaining:
      description: Requests remaining in the current window.
      schema:
        type: integer
        example: 599
    RateLimitReset:
      description: UTC instant when the current window ends.
      schema:
        type: string
        format: date-time
  schemas:
    FlowMetrics:
      type: object
      required:
        - object
        - flow_id
        - eligibility
        - since
        - until
        - attribution
        - entries
        - sent
        - delivered
        - failed
        - conversions
        - conversion_rate
        - revenue_in_cents
        - average_ticket_in_cents
        - nodes
      properties:
        object:
          type: string
          const: flow_metrics
        flow_id:
          type: string
          pattern: ^flw_[A-Za-z0-9_-]+$
        eligibility:
          type: string
          enum:
            - recovery
            - engagement_only
        since:
          type: string
          format: date-time
        until:
          type: string
          format: date-time
        attribution:
          type: object
          required:
            - model
            - window_days
            - scope
          properties:
            model:
              type: string
              const: last_touch
            window_days:
              type: integer
              minimum: 1
            scope:
              type: string
              const: abandoned_checkout
        entries:
          type: integer
          minimum: 0
        sent:
          type: integer
          minimum: 0
        delivered:
          type: integer
          minimum: 0
        failed:
          type: integer
          minimum: 0
        conversions:
          type: integer
          minimum: 0
        conversion_rate:
          type:
            - number
            - 'null'
        revenue_in_cents:
          type: integer
        average_ticket_in_cents:
          type: integer
        nodes:
          type: array
          items:
            type: object
            required:
              - node_id
              - channel
              - sent
              - delivered
              - opened
              - clicked
              - failed
              - conversions
              - revenue_in_cents
            properties:
              node_id:
                type: string
              channel:
                type: string
                enum:
                  - email
                  - sms
                  - whatsapp
              sent:
                type: integer
                minimum: 0
              delivered:
                type: integer
                minimum: 0
              opened:
                type:
                  - integer
                  - 'null'
                minimum: 0
              clicked:
                type: integer
                minimum: 0
              failed:
                type: integer
                minimum: 0
              conversions:
                type: integer
                minimum: 0
              revenue_in_cents:
                type: integer
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/Error'
    RateLimitErrorResponse:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          required:
            - retry_after
          properties:
            retry_after:
              type: integer
              minimum: 1
              description: Seconds before retrying.
    Error:
      type: object
      required:
        - type
        - message
        - request_id
      properties:
        type:
          type: string
          enum:
            - authentication_error
            - conflict
            - internal_error
            - invalid_request
            - not_found
            - permission_denied
            - rate_limited
            - validation_error
        message:
          type: string
        param:
          type: string
        request_id:
          type: string
          pattern: ^req_[a-f0-9]{24}$
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: bvt_live_...
      description: API key created in the organization settings.

````