Pular para o conteúdo principal
GET
Prévia de segmento por engajamento em campanha

Autorizações

Authorization
string
header
obrigatório

API key criada nas configurações da organização.

Parâmetros de consulta

campaign_ids
string
obrigatório

IDs das campanhas de WhatsApp Oficial (tcp_...), separados por vírgula. Até 50.

engagement
enum<string>
obrigatório

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.

Opções disponíveis:
engaged,
not_engaged,
received
purchases
enum<string>

Mantém quem não tem (none) ou tem (any) compra concluída no período. Exige purchases_from.

Opções disponíveis:
none,
any
purchases_from
string<date-time>

Início do período de compras (inclusivo), em ISO 8601 com fuso.

purchases_to
string<date-time>

Fim do período de compras (exclusivo), em ISO 8601 com fuso. Sem ele, o período fica aberto.

only_site_base
boolean
padrão:true

Se true (padrão), deixa de fora os clientes que pertencem só às unidades físicas, como nas campanhas da marca.

sample_size
integer
padrão:5

Quantidade de clientes na amostra.

Intervalo obrigatório: 0 <= x <= 20

Resposta

Prévia do segmento por engajamento. Nada foi salvo.

object
string
obrigatório
Allowed value: "campaign_engagement_preview"
customer_count
integer
obrigatório

Clientes que atendem aos critérios.

Intervalo obrigatório: x >= 0
reachable_count
integer
obrigatório

Desses, os que um envio de WhatsApp alcança (com telefone e sem opt-out).

Intervalo obrigatório: x >= 0
breakdown
object
obrigatório
campaigns
object[]
obrigatório
sample
object[]
obrigatório
snapshot_at
string<date-time>
obrigatório