Skip to main content

liveEvents

Streams a site's live visitor activity (visits, clicks, errors, form and e-commerce events, goal conversions, survey responses, and similar). On subscribe it replays up to the 100 most recent cached events, then pushes batches of new events about every five seconds; each poll reads at most 100 events from the past week. Requires a logged-in user with access to the site.

Credentials

Subscriptions are not supported for personal access token integrations: the GraphQL WebSocket transport that delivers them does not accept personal access tokens.

liveEvents(
siteId: Int!
): [LiveEvent]!

Arguments​

liveEvents.siteId ● Int! non-null scalar​

Accessible site id from sites; selects the site event stream.

Type​

LiveEvent object​

One recent site event delivered by liveEvents, with owner, site, event type, and event payload.