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

One-based result page.

Required range: x >= 1
Example:

1

limit
integer
default:50

Rows per page. Defaults to 50; maximum 100.

Required range: 1 <= x <= 100
Example:

50

pixelId
string<uuid> | null

Restrict the query to one accessible pixel. 403 when the pixel does not belong to the API-key organization

Example:

"00000000-0000-4000-8000-000000000001"

window
enum<string>

Overrides ruleAst.window for this request, using the shared window catalog

Available options:
24h,
7d,
14d,
30d,
90d,
all,
today,
3d,
mtd,
ytd
Example:

"30d"

Response

Qualified visitor data

data
object[]
required
meta
object
required