Skip to main content

Preview an unsaved filter (count + optional records)

POST 
/v1/segments/preview

Preview an unsaved filter: how many records match, and optionally a capped sample of them — without creating a segment.

entity_type and filter_config are required. This runs through the same filter engine the in-product Filter Builder uses, so the count you see here is the count the saved segment would produce.

Use it to iterate on a filter before committing it. Requires the segments:read scope.

Request​

Responses​

Successful Response

Last updated on