Skip to main content
GET
List privacy-bounded session summaries

Authorizations

X-API-Key
string
header
required

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

Path Parameters

visitorId
string
required

Visitor SHA-256 identifier from DataApiVisitor.emailHash

Pattern: ^[A-Fa-f0-9]{64}$
Example:

"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Query Parameters

timeframe
enum<string>
default:30d

Time window fixed when the first cursor page is requested.

Available options:
24h,
7d,
14d,
30d,
90d,
all
Example:

"30d"

limit
integer
default:50

Session rows per page. Defaults to 50; maximum 100.

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

50

cursor
string

Opaque signed nextCursor from the previous response. Do not construct or modify it.

Required string length: 1 - 1024
Example:

"eyJzIjoxNzU2NzE5MjAwLCJrIjoiYWFhYSIsImEiOjE3NTY3MjAwMDB9"

pixelId
string<uuid>

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

Example:

"00000000-0000-4000-8000-000000000001"

Response

Bounded session summaries

data
object[]
required
meta
object
required