Skip to main content
GET
Preview campaign engagement segment

Authorizations

Authorization
string
header
required

API key created in the organization settings.

Query Parameters

campaign_ids
string
required

WhatsApp Official campaign IDs (tcp_...), comma-separated. Up to 50.

engagement
enum<string>
required

engaged: read the message or clicked one of its links. not_engaged: the message was delivered and they neither read nor clicked. received: the message was delivered.

Available options:
engaged,
not_engaged,
received
purchases
enum<string>

Keeps customers with no (none) or at least one (any) completed purchase in the window. Requires purchases_from.

Available options:
none,
any
purchases_from
string<date-time>

Start of the purchase window (inclusive), in ISO 8601 with a timezone.

purchases_to
string<date-time>

End of the purchase window (exclusive), in ISO 8601 with a timezone. Without it, the window is open-ended.

only_site_base
boolean
default:true

If true (default), leaves out customers who belong only to physical units, as brand campaigns do.

sample_size
integer
default:5

Number of customers in the sample.

Required range: 0 <= x <= 20

Response

Engagement segment preview. Nothing was saved.

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

Customers who match the criteria.

Required range: x >= 0
reachable_count
integer
required

Of those, the ones a WhatsApp send can reach (with a phone and not opted out).

Required range: x >= 0
breakdown
object
required
campaigns
object[]
required
sample
object[]
required
snapshot_at
string<date-time>
required