Skip to content

Get Live Visitors

GET
/visitors/live

Raw live sessions in the window.

Identifying fields are REDACTED unless the key’s user holds a Signals write capability - the same rule the browser applies, resolved from the same principal.

Authorizations

Parameters

Query Parameters

time_window

Live window.

string
default: 30min
Allowed values: 5min 30min 1hr

Live window.

stream_id
Any of:
string

Comma-separated public keys, or “all”. Omit for every stream.

limit
integer
default: 10000 >= 1 <= 10000

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string