Skip to main content
POST
Query qualified visitor data via API key

Authorizations

X-API-Key
string
header
required

Organization API key (sk_...). Get yours from Settings > API Keys in the dashboard.

Body

application/json
segmentId
string<uuid> | null

Saved segment to query. Mutually exclusive with ruleAst.

ruleAst
any

Canonical RuleAST. Mutually exclusive with segmentId.

page
integer
default:1
Required range: x >= 1
limit
integer
default:50
Required range: 1 <= x <= 100

Response

Qualified visitor data

data
object[]
required
meta
object
required