Preview record filter | Runtype Documentation

Preview a filter — returns matching count and a small sample of records.

AuthorizationBearer

API key or Clerk session token

This endpoint expects an object.

typestringRequired1-255 characters

whereobjectOptional

Filter preview result

matchedCountinteger

sampleslist of objects

truncatedboolean

typestring

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

$	curl -X POST https://api.runtype.com/v1/records/preview-filter \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"type": "string"
>	}'