Skip to content

Visitors, visits, page views, bounce rate, time and goals, against the period before

GET
/v1/analytics/summary

A visit is a page view that starts a visit (arrived from outside the site, or a new session where visits carry ids). visitors is distinct visitor ids plus visits without an id (each counted once, so visitors_estimated is true when there were any), or null when it could not be counted. bounce_rate is the share of visits with an id that saw one page (null without such visits). previous is the same numbers for the period of the same length before, with its own from_rollups. Filter with filter_<dimension>=value (dimensions as in /breakdown).

History: Free 30 days, Indie 365, Builder 730. The last 90 days are read from raw events; older days from daily totals kept after raw events expire. When any day came from those, the answer has from_rollups: true and rollups: { from, to, missing_days } (the UTC dates read from them, and how many are not summed yet). Past 90 days: visitors are each day’s visitors added up (visitors_basis: "sum_of_daily"), a breakdown keeps each day’s top values and adds the rest as an (other) row, and filters, hourly buckets, visitor lists and funnels answer ANALYTICS_RAW_EVENTS_ONLY.

Auth: Secret key only.

Countries left out: the project’s saved excluded_countries (PATCH /v1/analytics/settings) are left out of this read, unless exclude_country names others (a comma list of two-letter codes, e.g. NO,CH; empty counts every country). The answer names the list it applied in excluded_countries. Past 90 days the totals, time series, goals, map and the country breakdown lose those countries (visits and page views exactly; engaged time, visits with ids, bounce, new visitors and goals in proportion, marked rollups.excluded_estimated; visitors become null); a breakdown or signups grouping by anything else answers ANALYTICS_RAW_EVENTS_ONLY with param: "exclude_country" when those countries had visits on those days.

period_days
integer
default: 7 >= 1 <= 1825
exclude_country
string
/^([A-Za-z][A-Za-z0-9](,[A-Za-z][A-Za-z0-9])*)?$/

Countries to leave out instead of the saved list, e.g. NO,CH; empty for none.

Summary

Error envelope. See error.code for the discriminator.

object
data
required
null
error
required
object
code
required
string
message
required
string
remediation
required
string
doc_url
string format: uri
param
string
request_id
string
meta
object
key
additional properties

Error envelope. See error.code for the discriminator.

object
data
required
null
error
required
object
code
required
string
message
required
string
remediation
required
string
doc_url
string format: uri
param
string
request_id
string
meta
object
key
additional properties