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

# Prévia de segmento por engajamento em campanha

> Conta e mostra uma amostra dos clientes que interagiram (ou não) com campanhas de WhatsApp Oficial, sem salvar nada. Quem recebeu várias das campanhas conta uma vez, e quem interagiu com qualquer uma delas conta como engaged. Mensagens com falha, canceladas ou não enviadas nunca contam como recebidas. breakdown divide todo o público que as campanhas tentaram alcançar entre quem interagiu, quem não interagiu e quem não recebeu, então uma prévia responde às duas listas. Encontre os IDs das campanhas em GET /v1/template-campaigns.



## OpenAPI

````yaml /openapi.json get /v1/segments/campaign-engagement/preview
openapi: 3.1.0
info:
  title: Bevits API
  version: 1.0.0
  description: >-
    API pública para consultar dados de CRM, compras e automação de uma
    organização Bevits, criar automações como rascunho para revisão e ativação,
    criar campanhas de WhatsApp Oficial como rascunho e montar segmentos e tags
    de clientes.
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.bevits.com
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Sistema
    description: Disponibilidade da API.
  - name: Identidade
    description: Identidade da organização e da API key.
  - name: Clientes
    description: Clientes e suas relações.
  - name: Segmentos
    description: Segmentos de clientes.
  - name: Compras
    description: Compras importadas das integrações.
  - name: Dados do CRM
    description: Tags e definições de atributos.
  - name: Automações
    description: Flows de automação.
  - name: Campanhas
    description: Campanhas de e-mail.
  - name: Conta e marca
    description: Contexto da conta, identidade da marca e imagens.
  - name: Receitas
    description: Automações prontas criadas a partir de receitas, com desfazer.
  - name: Templates de e-mail
    description: Criação e importação de templates de e-mail.
  - name: Eventos
    description: Eventos personalizados enviados pela loja e seus tipos.
paths:
  /v1/segments/campaign-engagement/preview:
    get:
      tags:
        - Segmentos
      summary: Prévia de segmento por engajamento em campanha
      description: >-
        Conta e mostra uma amostra dos clientes que interagiram (ou não) com
        campanhas de WhatsApp Oficial, sem salvar nada. Quem recebeu várias das
        campanhas conta uma vez, e quem interagiu com qualquer uma delas conta
        como engaged. Mensagens com falha, canceladas ou não enviadas nunca
        contam como recebidas. breakdown divide todo o público que as campanhas
        tentaram alcançar entre quem interagiu, quem não interagiu e quem não
        recebeu, então uma prévia responde às duas listas. Encontre os IDs das
        campanhas em GET /v1/template-campaigns.
      operationId: previewCampaignEngagementSegment
      parameters:
        - name: campaign_ids
          in: query
          required: true
          description: >-
            IDs das campanhas de WhatsApp Oficial (tcp_...), separados por
            vírgula. Até 50.
          schema:
            type: string
          example: tcp_8f2k1m,tcp_3j9x0a
        - name: engagement
          in: query
          required: true
          description: >-
            engaged: leu a mensagem ou clicou em um link dela. not_engaged: a
            mensagem foi entregue e a pessoa não leu nem clicou. received: a
            mensagem foi entregue.
          schema:
            type: string
            enum:
              - engaged
              - not_engaged
              - received
        - name: purchases
          in: query
          description: >-
            Mantém quem não tem (none) ou tem (any) compra concluída no período.
            Exige purchases_from.
          schema:
            type: string
            enum:
              - none
              - any
        - name: purchases_from
          in: query
          description: Início do período de compras (inclusivo), em ISO 8601 com fuso.
          schema:
            type: string
            format: date-time
        - name: purchases_to
          in: query
          description: >-
            Fim do período de compras (exclusivo), em ISO 8601 com fuso. Sem
            ele, o período fica aberto.
          schema:
            type: string
            format: date-time
        - name: only_site_base
          in: query
          description: >-
            Se true (padrão), deixa de fora os clientes que pertencem só às
            unidades físicas, como nas campanhas da marca.
          schema:
            type: boolean
            default: true
        - name: sample_size
          in: query
          description: Quantidade de clientes na amostra.
          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: Prévia do segmento por engajamento. Nada foi salvo.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CampaignEngagementPreview'
    InvalidRequest:
      description: Parâmetro de rota inválido.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: API key ausente, inválida, expirada ou revogada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              type: authentication_error
              message: Invalid API key.
              request_id: req_07f6cdc3c20249d6afcd90b4
    ValidationError:
      description: Um parâmetro não passou pela validação.
      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: Limite de requisições excedido.
      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: Erro inesperado no 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 atendem aos critérios.
        reachable_count:
          type: integer
          minimum: 0
          description: >-
            Desses, os que um envio de WhatsApp alcança (com telefone e sem
            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 até uma nova tentativa.
    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 estável e legível por máquina dentro de type, como
            invalid_event_name. Presente quando o erro tem um motivo nomeado.
        message:
          type: string
        param:
          type: string
          description: >-
            Caminho completo do campo com problema, como customer.email ou
            events[3].name.
        suggestion:
          type: string
          description: Um valor que seria aceito, quando existe um óbvio.
        request_id:
          type: string
          pattern: ^req_[a-f0-9]{24}$
  headers:
    RetryAfter:
      description: Segundos até uma nova tentativa.
      schema:
        type: integer
        minimum: 1
    RateLimitLimit:
      description: Limite total da janela atual.
      schema:
        type: integer
        example: 600
    RateLimitRemaining:
      description: Requisições restantes na janela atual.
      schema:
        type: integer
        example: 599
    RateLimitReset:
      description: Instante UTC em que a janela atual termina.
      schema:
        type: string
        format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: bvt_live_...
      description: API key criada nas configurações da organização.

````

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