Skip to content

Everyone who came: visits, the days they came, what they reached

GET
/v1/analytics/visitors

A total cannot show a path, so this groups the same events by person. Each visitor: visits, days they were seen, longest_run of days in a row, pageviews, pages_per_visit, engaged_seconds, where they came from, where they were, and the goals they reached. Most recently seen first. Threaded by the first-party visitor id, never an IP address, so only visits that may carry an id appear here: in the no-cookies mode, or for a visitor who said no, there is no id to thread and those visits are in the totals but not in this list. A visitor is a browser, not a person: known_people gives how many of the people you identified (total) came on more than one visitor id (on_several_ids: another device, or a browser that clears its cookies on close) and how many ids they used between them (ids). Raw events only: up to 90 days (ANALYTICS_RAW_EVENTS_ONLY beyond).

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 <= 90
limit
integer
default: 50 >= 1 <= 200
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.

Visitors

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