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

# Vista previa de segmento

> Muestra cuántos contactos coinciden con las reglas del segmento.



## OpenAPI

````yaml /es/contacts-api/api-reference/openapi-contacts.json get /v1/segments/{segmentId}/preview
openapi: 3.0.3
info:
  title: Notificar contactos API, etiquetas y audiencia
  description: >-
    API para **CRUD de contactos**, **etiquetas**, **temas**, **segmentos** y
    **campañas** (plantilla + audiencia + canales).


    **Contacto:** al menos uno de los **teléfono** o **correo electrónico**
    (único por espacio de trabajo). **Idiomas:** `languages` es una serie de
    códigos BCP-47 permitidos (enumerados en **`GET
    /v1/meta/contact-locales`**); orden = prioridad. **Telegram:** use
    **`telegramLinks`** (`instanceId` + `peer`) para múltiples instancias de
    Telegram en el mismo espacio de trabajo; **`telegramPeer`** permanece como
    un acceso directo heredado (rellena el enlace en la **instancia
    predeterminada de Telegram** del espacio de trabajo). En la campaña, el par
    utilizado es el de **`telegramInstanceId`** de la campaña (o
    predeterminado), con *respaldo* a `telegramPeer`.


    **Campañas:** `channels` puede incluir `whatsapp`, `sms`, `email`,
    `telegram`. Cada canal enumerado debe estar **habilitado en la plantilla**.
    **`instanceId`** = WhatsApp; **`telegramInstanceId`** = Telegrama.


    **Tarjeta WhatsApp:** `POST /v1/whatsapp/messages` con `type: "contact"` y
    `payload.contactId`.


    **Autenticación:** `Authorization: Bearer sk_live_xxxxx` o `x-api-key`.


    **Alcances:** `contacts:*`, `tags:*`, `topics:*`, `segments:*`,
    `campaigns:*` (incluye `campaigns:run`).


    **Extras de campaña:** `POST .../cancel` (BORRADOR/PROGRAMADO), `GET
    .../stats` y `GET .../recipients` (actualización/lectura de alcances).
    Ejecutar devuelve `runId`. Grupo de envío de WhatsApp: panel de control.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Producción
security:
  - ntfContactBearerAuth: []
  - ntfContactApiKeyHeader: []
tags:
  - name: Contatos
    description: >-
      CRUD de contactos del espacio de trabajo (teléfono o correo electrónico;
      etiquetas)
  - name: Tags
    description: Tags (etiquetas) para vincular a contactos
  - name: Temas
    description: Temas de comunicación (marketing/inscripción por tema)
  - name: Segmentos
    description: >-
      Segmentos de audiencia (DSL v1). Reglas: etiqueta, propiedad, campo de
      contacto, tema, recibirMarketing. Segmentos de ámbitos:
      leer|crear|actualizar|eliminar.
  - name: Campanhas
    description: Campañas multicanal con plantilla; ejecución vía POST .../ejecutar
paths:
  /v1/segments/{segmentId}/preview:
    get:
      tags:
        - Segmentos
      summary: Vista previa de segmento
      description: Muestra cuántos contactos coinciden con las reglas del segmento.
      operationId: ntfContact_getV1SegmentPreview
      parameters:
        - name: segmentId
          in: path
          required: true
          schema:
            type: string
        - name: page
          in: query
          schema:
            type: string
        - name: limit
          in: query
          schema:
            type: string
      responses:
        '200':
          description: '`data` + `pagination`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfContact_SegmentPreviewResponse'
              examples:
                ok:
                  summary: Avance
                  value:
                    success: true
                    data:
                      - id: clcontact01
                        name: Maria Silva
                        phone: '5511999999999'
                        email: maria@email.com
                        receiveMarketing: true
                    pagination:
                      total: 42
                      totalCapped: false
                      page: 1
                      limit: 20
                      totalPages: 3
        '400':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfContact_ErrorResponse'
        '401':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfContact_ErrorResponse'
        '402':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfContact_ErrorResponse'
        '403':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfContact_ErrorResponse'
        '404':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfContact_ErrorResponse'
components:
  schemas:
    NtfContact_SegmentPreviewResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/NtfContact_SegmentPreviewRow'
        pagination:
          $ref: '#/components/schemas/NtfContact_Pagination'
      example:
        success: true
        data:
          - id: clcontact01
            name: Maria Silva
            phone: '5511999999999'
            email: maria@email.com
            receiveMarketing: true
        pagination:
          total: 42
          totalCapped: false
          page: 1
          limit: 20
          totalPages: 3
    NtfContact_ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          description: >-
            Etiqueta de error de estilo HTTP (por ejemplo, no autorizado,
            solicitud incorrecta, no encontrada).
        message:
          type: string
          description: >-
            Mensaje legible por humanos para usuarios finales (localizado a
            través de Accept-Language/x-locale cuando corresponda).
        code:
          type: string
          description: >-
            Código API v1 estable (enumeración). Siempre presente en los
            errores. Úselo con el estado HTTP para decidir reintentar o
            corregir. Ver [Respuestas de
            error](/es/guides/conceitos/resposta-de-erros).
      required:
        - success
        - error
        - message
        - code
    NtfContact_SegmentPreviewRow:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
          nullable: true
        phone:
          type: string
          nullable: true
        email:
          type: string
          nullable: true
        receiveMarketing:
          type: boolean
      example:
        id: clcontact01
        name: Maria Silva
        phone: '5511999999999'
        email: maria@email.com
        receiveMarketing: true
    NtfContact_Pagination:
      type: object
      properties:
        total:
          type: integer
        page:
          type: integer
        limit:
          type: integer
        totalPages:
          type: integer
        totalCapped:
          type: boolean
          description: >-
            Verdadero cuando el total estimado ha alcanzado el límite máximo del
            recuento interno.
          example: false
  securitySchemes:
    ntfContactBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'Autorización: Portador sk_live_xxxxx'
    ntfContactApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: 'x-api-clave: sk_live_xxxxx'

````