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.

Headers

X-Whitelabel-Slug
string

Optional tenant context for admin-key operations without an organization target, such as creating an organization. Defaults to the master tenant. Must match an explicit target organization when both are supplied. Does not limit the key’s platform authority.

Required string length: 1 - 100
X-Organization-Id
string<uuid>

Target organization for admin-key requests on organization-context routes, including Data API, intent audiences and dashboard routes without an organization path parameter. Required on those routes. When supplied with an organization path parameter, both must identify the same organization; conflicting targets return 400. Does not grant access to customer credentials.

Query Parameters

email
string<email>

Exact primary or known alias email. When present, the response is a single visitor journey rather than a list. Cannot be combined with visitStatus or backAfter30Days filters.

Example:

"alex@example.test"

visitStatus
enum<string>

Status of the latest qualifying session in the selected period. new means it starts at this person's first recorded visit to the organization; seen_before means an earlier recorded visit exists, including outside the selected period or pixel. Known email aliases share history. This is recorded history, not proof of no untracked visits. Null means unavailable or inconsistent history, or the viewer lacks organization-wide pixel access. Existing firstSeen and returning-visitor metrics are unchanged. List mode only: omit for all; applied before pagination and totals.

Available options:
new,
seen_before
Example:

"new"

backAfter30Days
enum<string>

True when the latest qualifying session starts at least 30 full 24-hour days after the most recent recorded activity in an earlier non-bot session for this person in this organization. Earlier visits on other pixels or outside the selected period and rule filters still count. False means a known first visit or a shorter gap. Null means insufficient or inconsistent recorded history, or restricted pixel access. This is an additional badge, not a replacement for visitStatus; unknown history is never treated as inactivity. List mode only: use the literal query value true or false; omit for all. False excludes unknowns. Combined with visitStatus using AND, before pagination and totals.

Available options:
true,
false
Example:

"true"

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

Exact visited website host (for example, example.test), not a URL or wildcard. Restricts people and their session activity within the API-key organization. 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