Count the contacts a rule would select
Counts the contacts a rule selects right now, without creating a segment and without materialising anything. This is how you check a rule is neither too narrow to be worth sending to nor too wide to be safe BEFORE it becomes an audience something can mail. IT RETURNS A COUNT AND NO CONTACT IDS. A preview answers whether a rule is the right size, not who is in it, and the people behind the number are personal data that read_segments is not a grant over. Reading contacts is what the marketing-contacts family is for and it costs read_marketing_contacts on top. GATED ON THE WRITE SCOPE even though it stores nothing. It is a dry run of an authoring step, and under a read grant it would be an arbitrary aggregate query engine over the store’s contact database.
Authorizations
A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.
Headers
A unique key per logical write. Replaying a request with the same key returns the first response byte for byte instead of applying the write twice.
Body
The tree to evaluate. Same shape and same closed vocabulary as the create's, and it need not belong to a segment that exists. Nothing is stored and no membership is materialised; only the count comes back.
Response
Success
