Saltar al contenido principal
POST
Vista previa de segmento

Autorizaciones

Authorization
string
header
requerido

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

Cuerpo

application/json
conditions
object[]
requerido

Condiciones del catálogo de filtros (GET /v1/segment-builder/catalog). Hasta 30.

Required array length: 1 - 30 elements

Una condición de un segmento por filtros. El mismo formato entra en la creación, la actualización y la vista previa y vuelve en GET /v1/segments/{segment_id}.

match
enum<string>

all: clientes que cumplen todas las condiciones. any: clientes que cumplen al menos una.

Opciones disponibles:
all,
any
sample_size
integer
predeterminado:5

Cantidad de clientes en la muestra.

Rango requerido: 0 <= x <= 20

Respuesta

Vista previa del segmento. No se guardó nada.

object
string
requerido
Allowed value: "segment_preview"
customer_count
integer
requerido
Rango requerido: x >= 0
whatsapp_reachable_count
integer
requerido

Clientes que cumplen las condiciones, con teléfono y sin opt-out.

Rango requerido: x >= 0
email_reachable_count
integer
requerido

Clientes que cumplen las condiciones, con correo y suscritos para recibir correos.

Rango requerido: x >= 0
match
enum<string>
requerido

all: clientes que cumplen todas las condiciones. any: clientes que cumplen al menos una.

Opciones disponibles:
all,
any
conditions
object[]
requerido

Una condición de un segmento por filtros. El mismo formato entra en la creación, la actualización y la vista previa y vuelve en GET /v1/segments/{segment_id}.

sample
object[]
requerido
evaluated_at
string<date-time>
requerido