Skip to content

Get Aggregated Live Visitors

GET
/visitors/live/aggregated

Live sessions rolled up per visitor. Same PII rule as /live.

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: 1000 >= 1 <= 5000
include_bots

Also count bot and crawler traffic. Off by default: events from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded.

boolean

Also count bot and crawler traffic. Off by default: events from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded.

include_internal

Also count internal traffic. Off by default: the graph8 app (app.graph8.com), local development hosts and your own team members (member emails and company email domains) are excluded.

boolean

Also count internal traffic. Off by default: the graph8 app (app.graph8.com), local development hosts and your own team members (member emails and company email domains) are excluded.

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
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

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