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

# Vista previa de segmento por interacción con campañas

> Cuenta y muestra una muestra de los clientes que interactuaron (o no) con campañas de WhatsApp Oficial, sin guardar nada. Quien recibió varias de las campañas cuenta una vez, y quien interactuó con cualquiera de ellas cuenta como engaged. Los mensajes fallidos, cancelados o no enviados nunca cuentan como recibidos. breakdown divide todo el público que las campañas intentaron alcanzar entre quien interactuó, quien no interactuó y quien no recibió, así que una vista previa responde a las dos listas. Encuentra los IDs de las campañas en GET /v1/template-campaigns.



## OpenAPI

````yaml /openapi.es.json get /v1/segments/campaign-engagement/preview
openapi: 3.1.0
info:
  title: API de Bevits
  version: 1.0.0
  description: >-
    API pública para consultar datos de CRM, compras y automatización de una
    organización de Bevits, crear automatizaciones como borrador para revisarlas
    y activarlas, crear campañas de WhatsApp Oficial como borrador y armar
    segmentos y etiquetas de clientes.
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.bevits.com
    description: Producción
security:
  - bearerAuth: []
tags:
  - name: Sistema
    description: Disponibilidad de la API.
  - name: Identidad
    description: Identidad de la organización y de la clave API.
  - name: Clientes
    description: Clientes y sus relaciones.
  - name: Segmentos
    description: Segmentos de clientes.
  - name: Compras
    description: Compras importadas desde las integraciones.
  - name: Datos del CRM
    description: Etiquetas y definiciones de atributos.
  - name: Automatizaciones
    description: Flows de automatización.
  - name: Campañas
    description: Campañas de email.
  - name: Cuenta y marca
    description: Contexto de la cuenta, identidad de la marca e imágenes.
  - name: Recetas
    description: Automatizaciones listas creadas a partir de recetas, con deshacer.
  - name: Plantillas de email
    description: Creación e importación de plantillas de correo.
  - name: Eventos
    description: Eventos personalizados enviados por la tienda y sus tipos.
paths:
  /v1/segments/campaign-engagement/preview:
    get:
      tags:
        - Segmentos
      summary: Vista previa de segmento por interacción con campañas
      description: >-
        Cuenta y muestra una muestra de los clientes que interactuaron (o no)
        con campañas de WhatsApp Oficial, sin guardar nada. Quien recibió varias
        de las campañas cuenta una vez, y quien interactuó con cualquiera de
        ellas cuenta como engaged. Los mensajes fallidos, cancelados o no
        enviados nunca cuentan como recibidos. breakdown divide todo el público
        que las campañas intentaron alcanzar entre quien interactuó, quien no
        interactuó y quien no recibió, así que una vista previa responde a las
        dos listas. Encuentra los IDs de las campañas en GET
        /v1/template-campaigns.
      operationId: previewCampaignEngagementSegment
      parameters:
        - name: campaign_ids
          in: query
          required: true
          description: >-
            IDs de las campañas de WhatsApp Oficial (tcp_...), separados por
            comas. Hasta 50.
          schema:
            type: string
          example: tcp_8f2k1m,tcp_3j9x0a
        - name: engagement
          in: query
          required: true
          description: >-
            engaged: leyó el mensaje o hizo clic en uno de sus enlaces.
            not_engaged: el mensaje fue entregado y la persona no lo leyó ni
            hizo clic. received: el mensaje fue entregado.
          schema:
            type: string
            enum:
              - engaged
              - not_engaged
              - received
        - name: purchases
          in: query
          description: >-
            Mantiene a quienes no tienen (none) o tienen (any) una compra
            concluida en el período. Exige purchases_from.
          schema:
            type: string
            enum:
              - none
              - any
        - name: purchases_from
          in: query
          description: >-
            Inicio del período de compras (inclusivo), en ISO 8601 con zona
            horaria.
          schema:
            type: string
            format: date-time
        - name: purchases_to
          in: query
          description: >-
            Fin del período de compras (exclusivo), en ISO 8601 con zona
            horaria. Sin él, el período queda abierto.
          schema:
            type: string
            format: date-time
        - name: only_site_base
          in: query
          description: >-
            Si es true (por defecto), deja fuera a los clientes que pertenecen
            solo a las unidades físicas, como en las campañas de la marca.
          schema:
            type: boolean
            default: true
        - name: sample_size
          in: query
          description: Cantidad de clientes en la muestra.
          schema:
            type: integer
            minimum: 0
            maximum: 20
            default: 5
      responses:
        '200':
          $ref: '#/components/responses/CampaignEngagementPreview'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          $ref: '#/components/responses/ValidationError'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  responses:
    CampaignEngagementPreview:
      description: Vista previa del segmento por interacción. No se guardó nada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CampaignEngagementPreview'
    InvalidRequest:
      description: Parámetro de ruta inválido.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Clave API ausente, inválida, expirada o revocada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              type: authentication_error
              message: Invalid API key.
              request_id: req_07f6cdc3c20249d6afcd90b4
    ValidationError:
      description: Un parámetro no superó la validación.
      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: Límite de solicitudes superado.
      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: Error inesperado en el servidor.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    CampaignEngagementPreview:
      type: object
      required:
        - object
        - customer_count
        - reachable_count
        - breakdown
        - campaigns
        - sample
        - snapshot_at
      properties:
        object:
          type: string
          const: campaign_engagement_preview
        customer_count:
          type: integer
          minimum: 0
          description: Clientes que cumplen los criterios.
        reachable_count:
          type: integer
          minimum: 0
          description: >-
            De ellos, los que un envío de WhatsApp alcanza (con teléfono y sin
            opt-out).
        breakdown:
          $ref: '#/components/schemas/CampaignEngagementBreakdown'
        campaigns:
          type: array
          items:
            type: object
            required:
              - id
            properties:
              id:
                type: string
                pattern: ^tcp_[A-Za-z0-9_-]+$
              name:
                type: string
        sample:
          type: array
          items:
            type: object
            required:
              - object
              - id
            properties:
              object:
                type: string
                const: customer
              id:
                type: string
                pattern: ^cus_[A-Za-z0-9_-]+$
              name:
                type: string
              phone:
                type: string
        snapshot_at:
          type: string
          format: date-time
    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: Segundos antes de volver a intentarlo.
    CampaignEngagementBreakdown:
      type: object
      required:
        - engaged
        - not_engaged
        - not_received
      properties:
        engaged:
          type: integer
          minimum: 0
        not_engaged:
          type: integer
          minimum: 0
        not_received:
          type: integer
          minimum: 0
    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
        code:
          type: string
          description: >-
            Motivo estable y legible por máquina dentro de type, como
            invalid_event_name. Presente cuando el error tiene un motivo con
            nombre.
        message:
          type: string
        param:
          type: string
          description: >-
            Ruta completa del campo con problema, como customer.email o
            events[3].name.
        suggestion:
          type: string
          description: Un valor que sería aceptado, cuando existe uno obvio.
        request_id:
          type: string
          pattern: ^req_[a-f0-9]{24}$
  headers:
    RetryAfter:
      description: Segundos antes de volver a intentarlo.
      schema:
        type: integer
        minimum: 1
    RateLimitLimit:
      description: Límite total de la ventana actual.
      schema:
        type: integer
        example: 600
    RateLimitRemaining:
      description: Solicitudes restantes en la ventana actual.
      schema:
        type: integer
        example: 599
    RateLimitReset:
      description: Instante UTC en que termina la ventana actual.
      schema:
        type: string
        format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: bvt_live_...
      description: Clave API creada en la configuración de la organización.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.