Skip to content

Get Realtime

GET
/analytics/realtime

Get real-time analytics: active users in last 5 and 30 minutes.

Refresh rate: Poll every 10 seconds for real-time updates. Cache TTL: 10 seconds

Authorizations

Parameters

Query Parameters

write_key
Any of:
string

Comma-separated public keys to filter by

include_bots

Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed.

boolean

Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed.

include_internal

Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded.

boolean

Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded.

Header Parameters

X-Org-Id
Any of:
string

Responses

200

Successful Response

Standard analytics response wrapper.

object
data
required
Any of:
object
key
additional properties
any
meta
required

Metadata for analytics responses.

object
cache_ttl
integer
default: 60
cached
required
boolean
days
required
integer
org_id
required
string
query_time_ms
Any of:
number
stale
boolean
timestamp
required
string format: date-time
tracker_scoped
Any of:
boolean
success
boolean
default: true

422

Validation Error

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