Skip to main content
GET
Query 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.

Query Parameters

email
string<email>

Exact primary or known alias email. When present, the response is a single visitor journey rather than a list.

Example:

"alex@example.test"

page
integer
default:1

One-based page number for visitor-list mode. Each page contains up to 50 rows.

Required range: x >= 1
Example:

1

timeframe
enum<string>
default:30d

Activity window: today, 24h, 3d, 7d, 14d, 30d, mtd, 90d, ytd, or all.

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

"30d"

domain
string

Restrict visitor-list results to a tracked website domain. Mutually exclusive with pixelId.

Example:

"example.test"

pixelId
string<uuid>

Restrict results to one pixel owned by the API-key organization. An inaccessible or deleted pixel returns 403.

Example:

"00000000-0000-4000-8000-000000000001"

Response

Visitor list or a single visitor journey

data
object[]
required
meta
object
required