Skip to content

Get Audience Overview

GET
/analytics/audience/overview

Get audience overview: total users, new users, sessions, page views.

Typical use: Dashboard header metrics.

Authorizations

Parameters

Query Parameters

write_key
Any of:
string

Comma-separated public keys to filter by

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.

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
success
boolean
default: true

422

Validation Error

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