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

# Estadísticas de campaña

> Muestra envíos y rendimiento de la campaña.



## OpenAPI

````yaml /es/contacts-api/api-reference/openapi-contacts.json get /v1/campaigns/{campaignId}/stats
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/campaigns/{campaignId}/stats:
    get:
      tags:
        - Campanhas
      summary: Estadísticas de campaña
      description: Muestra envíos y rendimiento de la campaña.
      operationId: ntfContact_getV1CampaignStats
      parameters:
        - name: campaignId
          in: path
          required: true
          schema:
            type: string
        - name: runId
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: DE ACUERDO
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfContact_CampaignStatsResponse'
        '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_CampaignStatsResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/NtfContact_CampaignStats'
    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_CampaignStats:
      type: object
      description: Estadísticas de campaña (cuatro canales de creación)
      properties:
        campaign:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            status:
              type: string
            audienceCount:
              type: integer
              nullable: true
            startedAt:
              type: string
              format: date-time
              nullable: true
            completedAt:
              type: string
              format: date-time
              nullable: true
            lastRunAt:
              type: string
              format: date-time
              nullable: true
            scheduledFor:
              type: string
              format: date-time
              nullable: true
        run:
          type: object
          nullable: true
          properties:
            id:
              type: string
            status:
              type: string
              enum:
                - SCHEDULED
                - RUNNING
                - COMPLETED
                - FAILED
                - CANCELLED
            trigger:
              type: string
              enum:
                - MANUAL
                - SCHEDULED
            scheduledFor:
              type: string
              format: date-time
              nullable: true
            startedAt:
              type: string
              format: date-time
              nullable: true
            completedAt:
              type: string
              format: date-time
              nullable: true
            audienceCount:
              type: integer
              nullable: true
            errorMessage:
              type: string
              nullable: true
            errorLabel:
              type: string
              nullable: true
        funnel:
          type: object
          properties:
            whatsapp:
              $ref: '#/components/schemas/NtfContact_CampaignFunnelCounts'
            sms:
              $ref: '#/components/schemas/NtfContact_CampaignFunnelCounts'
            email:
              $ref: '#/components/schemas/NtfContact_CampaignFunnelCounts'
            telegram:
              $ref: '#/components/schemas/NtfContact_CampaignFunnelCounts'
        totals:
          $ref: '#/components/schemas/NtfContact_CampaignFunnelCounts'
        rates:
          type: object
          properties:
            deliveryRate:
              type: number
            readRate:
              type: number
            clickRate:
              type: number
            failureRate:
              type: number
        timeline:
          type: array
          items:
            type: object
            properties:
              hour:
                type: string
              sent:
                type: integer
              delivered:
                type: integer
              read:
                type: integer
              failed:
                type: integer
        cost:
          type: object
          properties:
            byChannel:
              type: array
              items:
                type: object
                properties:
                  channel:
                    $ref: '#/components/schemas/NtfContact_CampaignChannel'
                  count:
                    type: integer
                  credits:
                    type: number
                  cents:
                    type: integer
                  chargedAs:
                    type: string
                    nullable: true
            totalCredits:
              type: number
            totalCents:
              type: integer
        clicks:
          type: integer
        topErrors:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
              rawMessage:
                type: string
              count:
                type: integer
    NtfContact_CampaignFunnelCounts:
      type: object
      properties:
        queued:
          type: integer
        sent:
          type: integer
        delivered:
          type: integer
        read:
          type: integer
        clicked:
          type: integer
        responded:
          type: integer
        failed:
          type: integer
        total:
          type: integer
    NtfContact_CampaignChannel:
      type: string
      description: >-
        Canal de campaña (crear/actualizar): `whatsapp`, `sms`, `email`,
        `telegram`. Debe ser un subconjunto de canales habilitados en la
        plantilla. Las plantillas pueden habilitar RCS/Push/voz; La campaña
        creada a través de API/panel utiliza estos cuatro.
      enum:
        - whatsapp
        - sms
        - email
        - telegram
  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'

````