Skip to content

Visitors through each step in order, and each step's total

GET
/v1/analytics/funnels/{id}/report

Per step: visitors who reached it no earlier than they reached the step before (visitors with an id only; only first times are compared, so it may count a little low, never high), and total page views or goal completions from every visit. visitors_counted is false when visitors could not be followed (no ids, or the store could not answer). Funnels follow each visitor through raw events, kept 90 days: a longer period answers 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.

id
required
string
period_days
integer
default: 30 >= 1 <= 90
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.

Report

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