Preview contacts matching conditions
reach_previewContactsMatchingConditionsV1Preview contacts matching your segment conditions before saving. Check who a filter reaches and how many, without storing or modifying contact data.
Instructions
Preview the contacts matching a set of conditions without saving a segment.
The body is the same set of conditions accepted when creating or updating a segment, so this is how to check who a filter reaches, and how many, before persisting it. Nothing is stored and no contact is modified.
Call the segment filter attributes endpoint first to discover the valid attribute,
operator and value combinations.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number | |
| logic | Yes | How to combine multiple conditions | |
| search | No | Narrow the preview to contacts whose email matches | |
| sort_by | No | sort_by parameter | |
| per_page | No | Number of items per page | |
| conditions | Yes | Conditions a contact must satisfy to appear in the preview | |
| profileUuid | Yes | Profile uuid parameter | |
| sort_direction | No | sort_direction parameter |