API referenceSegments
Preview a segment filter
POST
/segments/previewHow many contacts a filter matches now, with a sample.
Authorization
apiKey AuthorizationBearer <token>
A project API key: Authorization: Bearer s0_…
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/segments/preview" \ -H "Content-Type: application/json" \ -d '{ "filter": { "property1": null, "property2": null } }'{ "object": "segment_preview", "contacts_count": 0, "sample": [ { "id": "string", "email": "string" } ]}