Skip to content

Get Engagement Overview

GET
/analytics/engagement/overview

Get engagement quality overview with trend indicators.

Returns:

  • total_sessions: Total session count
  • avg_session_depth: Average pages per session
  • avg_time_minutes: Average session duration in minutes
  • bounce_rate: Percentage of single-page sessions
  • engaged_sessions: Sessions with >1 page AND >30s duration
  • engaged_pct: Percentage of engaged sessions
  • Trend indicators: Period-over-period comparison for each metric

Typical use: Marketing Intelligence dashboard - Engagement Quality card.

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.

days

Number of days to analyze

integer
default: 30 >= 1 <= 365

Number of days to analyze

date_from
Any of:
string

Anchored window start (YYYY-MM-DD). Must be sent with date_to.

date_to
Any of:
string

Anchored window end (YYYY-MM-DD). Must be sent with date_from.

start_date
Any of:
string

Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC).

end_date
Any of:
string

Alias of date_to (YYYY-MM-DD). Sent alone, the window is the days days ending on end_date.

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