Saltar al contenido principal
GET
Vista previa de segmento por interacción con campañas

Autorizaciones

Authorization
string
header
requerido

Clave API creada en la configuración de la organización.

Parámetros de consulta

campaign_ids
string
requerido

IDs de las campañas de WhatsApp Oficial (tcp_...), separados por comas. Hasta 50.

engagement
enum<string>
requerido

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.

Opciones disponibles:
engaged,
not_engaged,
received
purchases
enum<string>

Mantiene a quienes no tienen (none) o tienen (any) una compra concluida en el período. Exige purchases_from.

Opciones disponibles:
none,
any
purchases_from
string<date-time>

Inicio del período de compras (inclusivo), en ISO 8601 con zona horaria.

purchases_to
string<date-time>

Fin del período de compras (exclusivo), en ISO 8601 con zona horaria. Sin él, el período queda abierto.

only_site_base
boolean
predeterminado:true

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.

sample_size
integer
predeterminado:5

Cantidad de clientes en la muestra.

Rango requerido: 0 <= x <= 20

Respuesta

Vista previa del segmento por interacción. No se guardó nada.

object
string
requerido
Allowed value: "campaign_engagement_preview"
customer_count
integer
requerido

Clientes que cumplen los criterios.

Rango requerido: x >= 0
reachable_count
integer
requerido

De ellos, los que un envío de WhatsApp alcanza (con teléfono y sin opt-out).

Rango requerido: x >= 0
breakdown
object
requerido
campaigns
object[]
requerido
sample
object[]
requerido
snapshot_at
string<date-time>
requerido